A Python 3 package with docs, lint, tests, and CI.
npm install @thejohnfreeman/generator-pythonA [Yeoman][] generator for a Python 3 package with docs, lint, tests, and
continuous integration.
[Yeoman]: https://yeoman.io/
Take a look at the sample
project built with
this generator. It is tested on Travis
CI and
published on PyPI with
documentation on Read the
Docs.
This generator assumes you are using [Poetry][] for managing Python packages.
It will use whatever Python version is activated in your environment.
I recommend using [pyenv][] to manage different versions of Python.
[pyenv]: https://github.com/pyenv/pyenv
[Poetry]: https://poetry.eustace.io/
``shell`Required
$ curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
$ yarn global add yo @thejohnfreeman/generator-pythonOptional
$ curl https://pyenv.run | bash
From within your project directory:
`shell`
$ pyenv local 3.6-dev
$ yo @thejohnfreeman/python
Although there are some parameters to this generator, such as the package name
and author, there are no optional pieces. Instead, I recommend you include
every generated file in your first commit, then delete the files you don't
want in your second commit, and go from there. That way, if you ever change
your mind later, you can resurrect the file that was generated for you, not by
re-running the generator and potentially overwriting other files, but by
asking Git for the version you
deleted:
`shell`
$ git checkout $(git rev-list -1 HEAD -- "$file")^ -- "$file"
| Option | Type | Description |
| ------ | ---- | ----------- |
| project_name | string | The project name. The project namespace is distinct from the package namespace. Think GitHub and Read the Docs, where your project coexists with projects from other language ecosystems. Default is the name of the current directory. |package_or_module
| | "package" | Whether this will be a package (directory) or module (single file). |package_name
| | string | The package (or module) name, i.e. the name your users will import.This will be the name of your PyPI package, too, but if that name is already taken, you will need to change it in pyproject.toml and README.rst. Default is the project name sanitized to a Python identifier. |version
| | string | The first version string. Default is 0.1.0. |author
| | string | The author name. Default comes from your Git configuration. This generator assumes a single author. If you need to add more, add them after the generator finishes. |email
| | string | The author email. Default comes from your Git configuration. |repository
| | string | The repository URL. Default is the project name within your namespace on github.com. |python` |
| "3.6‑dev""3.7‑dev""3.8‑dev" | The minimum supported version of Python. Default is 3.6-dev. |
[ISC]: https://tldrlegal.com/license/-isc-license#summary
[generator-license]: https://github.com/jozefizso/generator-license/
I explain my reasons on my
blog.