PyScaffold helps you setup a new Python project. Checkout out this demo project, which was set up using Pyscaffold. In order to install PyScaffold, just pick your favourite installation method:
# Good old pip pip install pyscaffold # Conda for the datascience fans conda install -c conda-forge pyscaffold # Or even pipx for the virtualenv aficionados pipx install pyscaffold
If you want to install all PyScaffold's extensions you can even:
pip install pyscaffold[all]
(More details of each method are available in the installation docs)
This will give you a new putup
command and you can just type:
putup my_project
This will create a new folder called my_project
containing a perfect project
template with everything you need for some serious coding. After the usual:
pip install -U pip setuptools setuptools_scm pip install -e .
you are all set and ready to go.
Type putup -h
to learn about more configuration options. PyScaffold assumes
that you have Git installed and set up on your PC,
meaning at least your name and email are configured.
The project template in my_project
provides you with following features:
All configuration can be done in setup.cfg
like changing the description,
URL, classifiers, installation requirements and so on as defined by setuptools.
That means in most cases it is not necessary to tamper with setup.py
.
In order to build a source or wheel distribution, just run
tox -e build
(python setup.py sdist
or python setup.py bdist_wheel
if you don't use tox).
Package and Files Data
Additional data, e.g. images and text files, that reside within your package and
are tracked by Git will automatically be included
(include_package_data = True
in setup.cfg
).
It is not necessary to have a MANIFEST.in
file for this to work.
Note that the include_package_data
option in setup.cfg
is only
guaranteed to be read when creating wheels. Other distribution methods might
behave unexpectedly (e.g. always including data files even when
include_package_data = False
). Therefore, the best option if you want to have
data files in your repository but not as part of the pip installable package
is to add them somewhere outside the src
directory (e.g. a files
directory in the root of the project, or inside tests
if you use them for
checks). Additionally you can exclude them explicitly via the
[options.packages.find] exclude
option in setup.cfg
.
Your project is an already initialised Git repository and setup.py
uses
the information of tags to infer the version of your project with the help of
setuptools_scm.
To use this feature, you need to tag with the format MAJOR.MINOR[.PATCH]
, e.g. 0.0.1
or 0.1
.
Run python setup.py --version
to retrieve the current PEP440-compliant
version. This version
will be used when building a package and is also accessible through
my_project.__version__
.
Unleash the power of Git by using its pre-commit hooks. This feature is
available through the --pre-commit
flag. After your project's scaffold
was generated, make sure pre-commit is installed, e.g. pip install pre-commit
,
then just run pre-commit install
.
A default .gitignore
file is also provided; it is
well adjusted for Python projects and the most common tools.
PyScaffold will prepare a docs directory with all you need to start writing
your documentation.
Start editing the file docs/index.rst
to extend the documentation.
The documentation also works with Read the Docs.
The Numpy and Google style docstrings are activated by default.
If you have Tox in your system, simply run tox -e docs
or tox -e
doctests
to compile the docs or run the doctests.
Alternatively, if you have make and Sphinx installed in your computer, build the
documentation with make -C docs html
and run doctests with
make -C docs doctest
. Just make sure Sphinx 1.3 or above is installed.
PyScaffold relies on pytest to run all automated tests defined in the subfolder
tests
. Some sane default flags for pytest are already defined in the
[tool:pytest]
section of setup.cfg
. The pytest plugin pytest-cov is used
to automatically generate a coverage report. It is also possible to provide
additional parameters and flags on the commandline, e.g., type:
pytest -h
to show the help of pytest (requires pytest to be installed in your system or virtualenv).
Projects generated with PyScaffold by default support running tests via Tox, a virtualenv management and test tool, which is very handy. If you run:
tox
in the root of your project, Tox will download its dependencies, build the package, install it in a virtualenv and run the tests using pytest, so you are sure everything is properly tested.
JUnit and Coverage HTML/XML
For usage with a continuous integration software JUnit and Coverage XML output
can be activated in setup.cfg
. Use the flag --cirrus
to generate
templates of the Cirrus CI configuration file .cirrus.yml
which even
features the coverage and stats system Coveralls.
Installation requirements of your project can be defined inside setup.cfg
,
e.g. install_requires = numpy; scipy
. To avoid package dependency problems,
it is common to not pin installation requirements to any specific version,
although minimum versions, e.g. sphinx>=1.3
, or maximum versions, e.g.
pandas<0.12
, are used sometimes.
More specific installation requirements should go into requirements.txt
.
This file can also be managed with the help of pip compile
from pip-tools
that basically pins packages to the current version, e.g. numpy==1.13.1
.
The packages defined in requirements.txt
can be easily installed with:
pip install -r requirements.txt
All licenses from choosealicense.com can be easily selected with the help
of the --license
flag.
PyScaffold comes with several extensions:
- If you want a project setup for a Data Science task, just use
--dsproject
after having installed pyscaffoldext-dsproject. - Create a Django project with the flag
--django
which is equivalent todjango-admin startproject my_project
enhanced by PyScaffold's features (requires the installation of pyscaffoldext-django). - Create a template for your own PyScaffold extension with
--custom-extension
after having installed pyscaffoldext-custom-extension withpip
. - Have a
README.md
based on MarkDown instead ofREADME.rst
by using--markdown
after having installed pyscaffoldext-markdown withpip
. - Add a
pyproject.toml
file according to PEP 518 to your template by using--pyproject
after having installed pyscaffoldext-pyproject withpip
. - With the help of Cookiecutter it is possible to further customize your project
setup with a template tailored for PyScaffold.
Just install pyscaffoldext-cookiecutter and add
--cookiecutter TEMPLATE
to yourputup
command to use a cookiecutter template which will be refined by PyScaffold afterwards. - ... and many more like
--gitlab
to create the necessary files for GitLab.
Find more extensions within the PyScaffold organisation and consider contributing your own.
All extensions can easily be installed with pip pyscaffoldext-NAME
.
Keep your project's scaffold up-to-date by applying
putup --update my_project
when a new version of PyScaffold was released.
An update will only overwrite files that are not often altered by users like
setup.py
. To update all files use --update --force
.
An existing project that was not setup with PyScaffold can be converted with
putup --force existing_project
. The force option is completely safe to use
since the git repository of the existing project is not touched!