makenew-python-package 1.0.3

Python package skeleton.

Description

Bootstrap a new Python package in less than a minute.

This package skeleton intentionally makes no assumptions about documentation generation, as that choice depends too heavily on project specific goals.

Features

• Package management with setuptools and hosting with PyPI.

• Dependency management with pip.

• Run tests with nose2.

• Lint with Pylint.

• Travis CI 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 python-package-v1.0.3

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.

Add this line to your application’s requirements.txt

makenew_python_package

and install it with

$ pip install -r requirements.txt

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

Alternatively, install it directly using pip with

$ pip install makenew_python_package

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

Install the development dependencies with

$ pip install -r requirements.devel.txt

Tests

Lint code with

$ python setup.py lint

Run tests with

$ python setup.py test

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 software can be used freely, see The Unlicense. The copyright text appearing below and elsewhere in this repository is for demonstration purposes only and does not apply to this software.

This Python package is licensed under the MIT license.

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.