Python package skeleton.
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.
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 python-package-v1.1.2
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.
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
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.
Add this line to your application’s requirements.txt
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
The makenew-python-package source is hosted on GitHub. Clone the project with
$ git clone https://github.com/makenew/python-package.git
Install the development dependencies with
$ pip install -r requirements.devel.txt
Lint code with
$ python setup.py lint
Run tests with
$ python setup.py test
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/makenew/python-package/fork).
- 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.
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.
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.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, Size & Hash SHA256 Hash Help||File Type||Python Version||Upload Date|
(6.5 kB) Copy SHA256 Hash SHA256
|Wheel||py3||May 17, 2016|
(3.7 kB) Copy SHA256 Hash SHA256
|Source||None||May 17, 2016|