Python package skeleton.
Project description
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 Pipenv.
Lint with Pylint.
Travis CI ready.
Consistent coding with EditorConfig.
Badges from Shields.io.
Bootstrapping a New Project
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
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.
Fill in the README Description section.
If choosing a license other than the one provided: update LICENSE.txt, the README License section, and setup.py with your chosen license.
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
Contributing
Please submit and comment on bug reports and feature requests.
To submit a patch:
Create your feature branch (git checkout -b my-new-feature).
Make changes. Write and run tests.
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin my-new-feature).
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 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for makenew-python-package-2.0.0b3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0e4955324d7828c909478b65b1d59c2f451d3d62ac67d09c0e28669e06f2d71 |
|
MD5 | ac08029dc80c4673909d4610cd8faabe |
|
BLAKE2b-256 | 58f9aa21ded9710aade7150392ff1a6c0bc74b58ffd5afeba2d0b4151538909c |
Hashes for makenew_python_package-2.0.0b3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5afba225e6758e7e8893cf67e0793d6b082720b42bfc685ef6544790d458451c |
|
MD5 | ba0011710dd7ac08808f47ea3d33b11d |
|
BLAKE2b-256 | 7b7e7f6b701970dca86b8c7daec88ae2fb0771b2e005bfc5220c0a8f2de03586 |