makenew-python-package 2.0.0

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

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.