makenew-pypackage 3.22.1

Package skeleton for a Python module.

Package skeleton for a Python module.

Description

Bootstrap a new Python package in less than a minute.

Features

• Publishing to PyPI.

• Secure dependency management with Poetry.

• Linting with Pylint.

• Uncompromising code formatting with Black.

• pytest helps you write better programs.

• Code coverage reporting with Codecov.

• Continuous testing and deployment with GitHub Actions.

• Keep a CHANGELOG.

• Consistent coding with EditorConfig.

• Badges from Shields.io.

Bootstrapping a New Project

1. Create an empty (non-initialized) repository on GitHub.

2. Clone the master 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 v1.2.0

3. Run

   $ ./makenew.sh

   This will replace the boilerplate, delete itself, remove the git remote, remove upstream tags, and stage changes for commit.

4. Create the required GitHub repository secrets

5. Review, commit, and push the changes to GitHub with

   $ git diff --cached
   $ git commit -m "Replace makenew boilerplate"
   $ git remote add origin [e-mail]:<user>/<new-pypackage>.git
   $ git push -u origin master

6. Ensure the GitHub action passes, then publish the initial version of the package with

   $ poetry install
   $ poetry version patch
   $ make version

Updating

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 [e-mail]:makenew/pypackage.git

You can then fetch and merge changes with

$ git fetch --no-tags upstream
$ git merge upstream/master

Changelog

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.

Installation

This package is registered on the Python Package Index (PyPI) as makenew-pypackage.

Install it with

$ poetry add makenew-pypackage

Development and Testing

Quickstart

$ 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.

Source Code

The source code is hosted on GitHub. Clone the project with

$ git clone https://github.com/makenew/pypackage.git

Requirements

You will need Python 3 and Poetry.

Install the development dependencies with

$ poetry install

Tests

Lint code with

$ make lint

Run tests with

$ make test

Run tests on changes with

$ make watch

Publishing

Use the poetry version command to release a new version. Then run make version to commit and push a new git tag which will trigger a GitHub action.

Publishing may be triggered using on the web using a workflow_dispatch on GitHub Actions.

GitHub Actions

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.

Secrets for Optional GitHub Actions

The version and format 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_USER: The GitHub user’s username.

• 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.

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/makenew/pypackage/fork).

2. Create your feature branch (git checkout -b my-new-feature).

3. Make changes.

4. Commit your changes (git commit -am ‘Add some feature’).

5. Push to the branch (git push origin my-new-feature).

6. Create a new Pull Request.

License

This Python package is licensed under the MIT license.

Warranty

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.