Skip to content

Commit e601a7e

Browse files
authored
Trying to update setuptools (#15)
1 parent 2e12fcd commit e601a7e

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# pyctdev: python packaging common tasks for developers
22

33
Tools (and documentation) to support common tasks across many similar
4-
projects, focusing on those making up [PyViz.org](http://pyviz.org).
4+
projects, focusing on those making up [HoloViz.org](http://holoviz.org).
55

66
**Note: documentation is draft/currently being written**
77

@@ -20,7 +20,7 @@ ecosystem_setup Common pip setup
2020
env_capture Report all information required to recreate current environment.
2121
env_create TODO: create named environment if it doesn't already exist.
2222
env_export TODO
23-
list_envs
23+
list_envs
2424
package_build Build pip package, then install and test all_quick (or other
2525
package_upload Upload pip packages to pypi
2626
test_all Run "all" tests
@@ -35,7 +35,7 @@ ecosystem_setup Common conda setup (must be run in base env).
3535
env_capture Report all information required to recreate current conda environment
3636
env_create Create named environment if it doesn't already exist
3737
env_export Generate a pinned environment.yaml from specified env, filtering against specified groups of deps.
38-
list_envs
38+
list_envs
3939
miniconda_download Download Miniconda3-latest
4040
miniconda_install Install Miniconda3-latest to location if not already present
4141
package_build Build and then test conda.recipe/ (or specified alternative).
@@ -52,13 +52,13 @@ so that people can run commands independently without installing
5252
doit+pyctdev. This means pyctdev can be viewed as:
5353

5454
* documentation of what all the common tasks are
55-
55+
5656
* documentation of the commands necessary to perform those tasks
5757

5858
* a way to expose gaps in underlying tools that we might like to
5959
fill (or exposes our lack of knowledge of how to use them, so we
6060
can be corrected :) )
61-
61+
6262
* a way to map relatively unchanging "high level tasks" (e.g. "run
6363
the unit tests") to underlying specific commands that might change over
6464
time (e.g. as the python packaging ecosystem changes) or that vary
@@ -67,7 +67,7 @@ doit+pyctdev. This means pyctdev can be viewed as:
6767
* our current best understanding of how to perform the various tasks
6868
(balancing the best possible way with what's practically possible
6969
in general, given what tools are currently widely available).
70-
70+
7171
The accompanying [background](background.md) document (even more draft
7272
than this one!) contains more details, along with explanations for
7373
choices. It's broken into the same sections, so can be read alongside
@@ -110,7 +110,7 @@ configuration files). (And once any python's available, doit can be
110110
used to install other pythons if necessary - currently miniconda and
111111
anaconda.) Having the same command to run on each platform helps ensure
112112
that testing, package building, and related tasks are done consistently
113-
across platforms, which is particularly important when developers use
113+
across platforms, which is particularly important when developers use
114114
one platform but users will download packages for another.
115115

116116
Other suggested tools used by pyctdev are also cross platform: tox,
@@ -124,7 +124,7 @@ conda ecosystem. E.g. `doit develop_install` will typically run `pip
124124
install -e .[tests]`, which installs the dependencies using pip and
125125
then does an editable install. Alternatively, `doit ecosystem=conda
126126
develop install` will install dependencies using conda, followed by an
127-
editable install. Projects can set a default ecosystem.
127+
editable install. Projects can set a default ecosystem.
128128

129129
The ability to install with pip or conda, create reproducible/isolated
130130
environments with python tools (virtualenv+pip, or pipenv) or with
@@ -150,13 +150,13 @@ widely supported by both python and conda tools. The dependencies
150150
listed in setup.py are used for:
151151

152152
* end-user pip packages
153-
153+
154154
* end-user conda packages
155-
155+
156156
* developers using conda
157-
157+
158158
* developers using pip
159-
159+
160160
* generating environment files (e.g. examples environment.yml)
161161

162162
The abstract dependencies may be transformed to more concrete ones,
@@ -244,16 +244,16 @@ package metadata only once. Currently this is in setup.py. Templating
244244
is then used for conda build. This prevents the common situation where
245245
descriptions, URLs, licenses, etc, are mismatched.
246246

247-
pyctdev expects project is being released first on pypi and on an
247+
pyctdev expects project is being released first on pypi and on an
248248
anaconda.org channel. From these sources, conda-forge can be updated, followed by
249249
anaconda defaults (but we are not necessarily the maintainers of those
250250
channels).
251251

252252
pyctdev is currently primarily supporting pure Python packages. While
253253
they may often have complex, platform specific dependencies, the
254-
packages controlled by pyct are so far all pure Python. Therefore
254+
packages controlled by pyct are so far all pure Python. Therefore
255255
we build noarch:python conda packages where possible. If we start
256-
maintaining packages with binary code, pyct will be extended
256+
maintaining packages with binary code, pyct will be extended
257257
to support platform-specific packages, but for now none of our
258258
packages require that.
259259

@@ -263,7 +263,7 @@ packages require that.
263263
For python/pip: typically just pypi.org. But other 'channels' can be
264264
specified. E.g. test.pypi.org, or a private server.
265265

266-
The conda packages we maintain for PyViz.org can usually be installed
266+
The conda packages we maintain for HoloViz.org can usually be installed
267267
on top of either anaconda defaults or conda-forge. We currently put
268268
them on anaconda.org pyviz (releases) and pyviz/label/dev (dev
269269
versions), and only our specific packages are on this channel. For a
@@ -280,7 +280,7 @@ conda-forge and defaults should be updated.
280280
### 11. How to structure project
281281

282282
Although it's not necessary, a common structure simplifies things
283-
across multiple similar projects. Pyviz projects typically have
283+
across multiple similar projects. HoloViz projects typically have
284284
repositories that look like:
285285

286286
```
@@ -318,7 +318,7 @@ projects, and how? Would rather not have a config file for pyctdev...)
318318
### 13. What's tested, and how.
319319

320320
There are various tools for running tests (e.g. pytest, nose). An aim
321-
of pyctdev is for our pyviz projects to all end up using the same
321+
of pyctdev is for our HoloViz projects to all end up using the same
322322
developer tools where possible. And to configure those tools in the
323323
same kind of way.
324324

@@ -329,9 +329,9 @@ same kind of way.
329329
* examples:
330330

331331
* notebooks run without error: pytest plugin nbsmoke
332-
332+
333333
* notebooks flakes: pytest plugin nbsmoke
334-
334+
335335
* notebooks "data tests": pytest plugin nbva
336336

337337
* performance/benchmark tests: (pytest-benchmark, custom stuff,
@@ -367,7 +367,7 @@ needs to know version (`__init__.py`; packaging: `setup.py`,
367367

368368
Storing in one place, and it being the tag rather than in the git repo
369369
source code, makes it easier to automate various other 'release time'
370-
tasks. Our pyviz projects generally use
370+
tasks. Our projects generally use
371371
[autover](https://github.com/pyviz/autover) (via param).
372372

373373
Versioning scheme:

pyctdev/_pip.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ def task_env_capture():
7777
def task_ecosystem_setup():
7878
"""Common pip setup
7979
80-
Updates to latest tox, twine, and wheel.
80+
Updates to latest tox, twine, and wheel and setuptools.
8181
"""
82-
return {'actions': ["pip install --upgrade tox twine wheel"]}
82+
return {'actions': ["pip install --upgrade tox twine wheel setuptools"]}
8383

8484

8585
########## PACKAGING ##########

0 commit comments

Comments
 (0)