Package skeleton for a Python module.
Bootstrap a new Python package in less than a minute.
- Publishing to PyPI.
- Secure dependency management with Poetry.
- Extremely fast Python linting and code formatting with Ruff.
- pytest helps you write better programs.
- Code coverage reporting with Codecov.
- Fully automated version management and package publishing with semantic-release.
- Continuous checks and tests with GitHub Actions.
- Keep a CHANGELOG.
- Consistent coding with EditorConfig.
- Badges from Shields.io.
- Start coding instantly with GitHub Codespaces.
Create an empty (non-initialized) repository on GitHub.
Clone the main branch of this repository with
$ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage $ cd new-pypackage
Optionally, reset to the latest release with
$ git reset --hard <version-tag>
Run
$ ./makenew.sh
This will replace the boilerplate, delete itself, remove the git remote, remove upstream tags, and stage changes for commit.
Create the required GitHub repository secrets
Review, commit, and push the changes to GitHub with
$ git diff --cached $ git commit -m "Replace makenew boilerplate" $ git remote add origin [email protected]:<user>/<new-pypackage>.git $ git push -u origin main
Ensure the GitHub action passes, then publish the initial version of the package with
$ poetry install $ poetry version patch $ make version
If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.
Add this as a new remote with
$ git remote rename origin upstream
and then configure your origin branch as normal.
Otherwise, add this as a new remote with
$ git remote add upstream [email protected]:makenew/pypackage.git
You can then fetch and merge changes with
$ git fetch --no-tags upstream $ git merge upstream/main
Note that CHANGELOG.md is just a template for this skeleton. The
actual changes for this project are documented in the commit history and
summarized under
Releases.
This package is registered on the Python Package Index (PyPI) as makenew-pypackage.
Install it with
$ poetry add makenew-pypackage
$ git clone https://github.com/makenew/pypackage.git $ cd pypackage $ poetry install
Run each command below in a separate terminal window:
$ make watch
Primary development tasks are defined in the Makefile.
The source code is hosted on GitHub. Clone the project with
$ git clone https://github.com/makenew/pypackage.git
You will need Python 3 and Poetry.
Install the development dependencies with
$ poetry install
Lint code with
$ make lint
Run tests with
$ make test
Run tests on changes with
$ make watch
New versions are created with poetry version.
New versions are released automatically with semantic-release as long as commits follow the Angular Commit Message Conventions.
Publish a new version by triggering a version workflow_dispatch on GitHub Actions. The version input will be passed as the first argument to poetry version.
This may be done on the web or using the GitHub CLI with
$ gh workflow run version.yml --raw-field version=<version>
GitHub Actions should already be configured: this section is for reference only.
The following repository secrets must be set on GitHub Actions.
PYPI_API_TOKEN: API token for publishing on PyPI.
These must be set manually.
The version, format, generate, and semantic-release GitHub actions require a user with write access to the repository including access to read and write packages. Set these additional secrets to enable the action:
GH_TOKEN: A personal access token for the user.GIT_USER_NAME: The name to set for Git commits.GIT_USER_EMAIL: The email to set for Git commits.GPG_PRIVATE_KEY: The GPG private key.GPG_PASSPHRASE: The GPG key passphrase.
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/makenew/pypackage/fork).
- Create your feature branch (git checkout -b my-new-feature).
- Make changes.
- Commit your changes (git commit -am 'Add some feature').
- Push to the branch (git push origin my-new-feature).
- Create a new Pull Request.
This Python package is licensed under the MIT license.
This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.