|
| 1 | +# Overview |
| 2 | + |
| 3 | +This project is merged with [skeleton](https://github.com/jaraco/skeleton). What is skeleton? It's the scaffolding of a Python project jaraco [introduced in his blog](https://blog.jaraco.com/a-project-skeleton-for-python-projects/). It seeks to provide a means to re-use techniques and inherit advances when managing projects for distribution. |
| 4 | + |
| 5 | +## An SCM Managed Approach |
| 6 | + |
| 7 | +While maintaining dozens of projects in PyPI, jaraco derives best practices for project distribution and publishes them in the [skeleton repo](https://github.com/jaraco/skeleton), a git repo capturing the evolution and culmination of these best practices. |
| 8 | + |
| 9 | +It's intended to be used by a new or existing project to adopt these practices and honed and proven techniques. Adopters are encouraged to use the project directly and maintain a small deviation from the technique, make their own fork for more substantial changes unique to their environment or preferences, or simply adopt the skeleton once and abandon it thereafter. |
| 10 | + |
| 11 | +The primary advantage to using an SCM for maintaining these techniques is that those tools help facilitate the merge between the template and its adopting projects. |
| 12 | + |
| 13 | +# Usage |
| 14 | + |
| 15 | +## new projects |
| 16 | + |
| 17 | +To use skeleton for a new project, simply pull the skeleton into a new project: |
| 18 | + |
| 19 | +``` |
| 20 | +$ git init my-new-project |
| 21 | +$ cd my-new-project |
| 22 | +$ git pull gh://jaraco/skeleton |
| 23 | +``` |
| 24 | + |
| 25 | +Now customize the project to suit your individual project needs. |
| 26 | + |
| 27 | +## existing projects |
| 28 | + |
| 29 | +If you have an existing project, you can still incorporate the skeleton by merging it into the codebase. |
| 30 | + |
| 31 | +``` |
| 32 | +$ git merge skeleton --allow-unrelated-histories |
| 33 | +``` |
| 34 | + |
| 35 | +The `--allow-unrelated-histories` is necessary because the history from the skeleton was previously unrelated to the existing codebase. Resolve any merge conflicts and commit to the master, and now the project is based on the shared skeleton. |
| 36 | + |
| 37 | +## Updating |
| 38 | + |
| 39 | +Whenever a change is needed or desired for the general technique for packaging, it can be made in the skeleton project and then merged into each of the derived projects as needed, recommended before each release. As a result, features and best practices for packaging are centrally maintained and readily trickle into a whole suite of packages. This technique lowers the amount of tedious work necessary to create or maintain a project, and coupled with other techniques like continuous integration and deployment, lowers the cost of creating and maintaining refined Python projects to just a few, familiar git operations. |
| 40 | + |
| 41 | +Thereafter, the target project can make whatever customizations it deems relevant to the scaffolding. The project may even at some point decide that the divergence is too great to merit renewed merging with the original skeleton. This approach applies maximal guidance while creating minimal constraints. |
| 42 | + |
| 43 | +# Features |
| 44 | + |
| 45 | +The features/techniques employed by the skeleton include: |
| 46 | + |
| 47 | +- PEP 517/518 based build relying on setuptools as the build tool |
| 48 | +- setuptools declarative configuration using setup.cfg |
| 49 | +- tox for running tests |
| 50 | +- A README.rst as reStructuredText with some popular badges, but with readthedocs and appveyor badges commented out |
| 51 | +- A CHANGES.rst file intended for publishing release notes about the project. |
| 52 | + |
| 53 | +## Packaging Conventions |
| 54 | + |
| 55 | +A pyproject.toml is included to enable PEP 517 and PEP 518 compatibility and declares the requirements necessary to build the project on setuptools (a minimum version compatible with setup.cfg declarative config). |
| 56 | + |
| 57 | +The setup.cfg file implements the following features: |
| 58 | + |
| 59 | +- Assumes universal wheel for release |
| 60 | +- Advertises the project's LICENSE file (MIT by default) |
| 61 | +- Reads the README.rst file into the long description |
| 62 | +- Some common Trove classifiers |
| 63 | +- Includes all packages discovered in the repo |
| 64 | +- Data files in the package are also included (not just Python files) |
| 65 | +- Declares the required Python versions |
| 66 | +- Declares install requirements (empty by default) |
| 67 | +- Declares setup requirements for legacy environments |
| 68 | +- Supplies two 'extras': |
| 69 | + - testing: requirements for running tests |
| 70 | + - docs: requirements for building docs |
| 71 | + - these extras split the declaration into "upstream" (requirements as declared by the skeleton) and "local" (those specific to the local project); these markers help avoid merge conflicts |
| 72 | +- Placeholder for defining entry points |
| 73 | + |
| 74 | +Additionally, the setup.py file declares `use_scm_version` which relies on [setuptools_scm](https://pypi.org/project/setuptools_scm) to do two things: |
| 75 | + |
| 76 | +- derive the project version from SCM tags |
| 77 | +- ensure that all files committed to the repo are automatically included in releases |
| 78 | + |
| 79 | +## Running Tests |
| 80 | + |
| 81 | +The skeleton assumes the developer has [tox](https://pypi.org/project/tox) installed. The developer is expected to run `tox` to run tests on the current Python version using [pytest](https://pypi.org/project/pytest). |
| 82 | + |
| 83 | +Other environments (invoked with `tox -e {name}`) supplied include: |
| 84 | + |
| 85 | + - a `build-docs` environment to build the documentation |
| 86 | + - a `release` environment to publish the package to PyPI |
| 87 | + |
| 88 | +A pytest.ini is included to define common options around running tests. In particular: |
| 89 | + |
| 90 | +- rely on default test discovery in the current directory |
| 91 | +- avoid recursing into common directories not containing tests |
| 92 | +- run doctests on modules and invoke flake8 tests |
| 93 | +- in doctests, allow unicode literals and regular literals to match, allowing for doctests to run on Python 2 and 3. Also enable ELLIPSES, a default that would be undone by supplying the prior option. |
| 94 | +- filters out known warnings caused by libraries/functionality included by the skeleton |
| 95 | + |
| 96 | +Relies a .flake8 file to correct some default behaviors: |
| 97 | + |
| 98 | +- allow tabs for indentation (legacy for jaraco projects) |
| 99 | +- disable mutually incompatible rules W503 and W504. |
| 100 | + |
| 101 | +## Continuous Integration |
| 102 | + |
| 103 | +The project is pre-configured to run tests in [Travis-CI](https://travis-ci.org) (.travis.yml). Any new project must be enabled either through their web site or with the `travis enable` command. In addition to running tests, an additional deploy stage is configured to automatically release tagged commits. The username and password for PyPI must be configured for each project using the `travis` command and only after the travis project is created. As releases are cut with [twine](https://pypi.org/project/twine), the two values are supplied through the `TWINE_USERNAME` and `TWINE_PASSWORD`. To configure the latter as a secret, run the following command: |
| 104 | + |
| 105 | +``` |
| 106 | +echo "TWINE_PASSWORD={password}" | travis encrypt |
| 107 | +``` |
| 108 | + |
| 109 | +Or disable it in the CI definition and configure it through the web UI. |
| 110 | + |
| 111 | +Features include: |
| 112 | +- test against Python 2 and 3 |
| 113 | +- run on Ubuntu Xenial |
| 114 | +- correct for broken IPv6 |
| 115 | + |
| 116 | +Also provided is a minimal template for running under Appveyor (Windows). |
| 117 | + |
| 118 | +## Building Documentation |
| 119 | + |
| 120 | +Documentation is automatically built by [Read the Docs](https://readthedocs.org) when the project is registered with it, by way of the .readthedocs.yml file. To test the docs build manually, a tox env may be invoked as `tox -e build-docs`. Both techniques rely on the dependencies declared in `setup.cfg/options.extras_require.docs`. |
| 121 | + |
| 122 | +In addition to building the sphinx docs scaffolded in `docs/`, the docs build a `history.html` file that first injects release dates and hyperlinks into the CHANGES.rst before incorporating it as history in the docs. |
| 123 | + |
| 124 | +## Cutting releases |
| 125 | + |
| 126 | +By default, tagged commits are released through the continuous integration deploy stage. |
0 commit comments