Python Package Skeleton

Package skeleton for an Python module.

Description

Bootstrap a new Python package in less than a minute.

Features

• Package management with setuptools and publishing to PyPI.
• Secure dependency management with Pipenv.
• Linting with Pylint.
• CircleCI ready.
• Keep a CHANGELOG.
• Consistent coding with EditorConfig.
• Badges from Shields.io.

Bootstrapping a New Project

1. Clone the master branch of this repository with

   $ git clone --single-branch https://github.com/makenew/python-package.git new-python-package
   $ cd new-python-package
   

   Optionally, reset to the latest release with

   $ git reset --hard v1.2.0
   

2. Run

   $ ./makenew.sh
   

   and follow the prompts. This will replace the boilerplate, delete itself, and stage changes for commit. This script assumes the project repository will be hosted on GitHub. For an alternative location, you must update the URLs manually.

3. Fill in the README Description section.

4. If choosing a license other than the one provided: update LICENSE.txt, the README License section, and setup.py with your chosen license.

5. Depending on how you name your tests, you may need to add them to the find_packages exclude list in setup.py.

Updating

If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.

If this repository is already set as origin, rename it to upstream 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 https://github.com/makenew/python-package.git

You can then fetch and merge changes with

$ git fetch 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_python_package.

Install it with

$ pipenv install makenew_python_package

If you are writing a Python package which will depend on this, add this to your requirements in setup.py.

Development and Testing

Source Code

The makenew-python-package source is hosted on GitHub. Clone the project with

$ git clone https://github.com/makenew/python-package.git

Requirements

You will need Python 3 with Pipenv.

Install the development dependencies with

$ pipenv install --dev

Tests

Lint code with

$ python setup.py lint

Run tests with

$ python setup.py test

Publishing

Update the CHANGELOG and the version number in setup.py. Then create a new commit and tag, e.g., the commit message should be like 1.0.0 and git tag v1.0.0. Then push the new git tag which will trigger a CircleCI publish job.

CircleCI

CircleCI should already be configured: this section is for reference only.

The following environment variables must be set on CircleCI:

• TWINE_USERNAME: Username for publishing on PyPI.
• TWINE_PASSWORD: Password for publishing on PyPI.

These may be set manually or by running the script ./circleci/envvars.sh.

Contributing

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/makenew/python-package/fork).
2. Create your feature branch (git checkout -b my-new-feature).
3. Make changes. Write and run tests.
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.