Package skeleton for a python module.
Package skeleton for an Python module.
Bootstrap a new Python package in less than a minute.
Bootstrapping a New Project
Create an empty (non-initialized) repository on GitHub.
Clone the master branch of this repository with
$ git clone --single-branch https://github.com/makenew/pypackage.git new-pypackage $ cd new-pypackage
Optionally, reset to the latest release with
$ git reset --hard v1.2.0
This will replace the boilerplate, delete itself, remove the git remote, remove upstream tags, and stage changes for commit.
Create the required CircleCI environment variables with
Review, commit, and push the changes to GitHub with
$ git diff --cached $ git commit -m "Replace makenew boilerplate" $ git remote add origin firstname.lastname@example.org:<user>/<new-python-package>.git $ git push -u origin master
Ensure the CircleCI build passes, then publish the initial version of the package with
$ pipenv install --dev $ pipenv run bumpversion patch $ git push $ git push --tags
If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.
Add this as a new remote 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 email@example.com:makenew/pypackage.git
You can then fetch and merge changes with
$ git fetch --no-tags 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.
Install it with
$ pipenv install makenew_pypackage
If you are writing a Python package which will depend on this, add this to your requirements in setup.py.
Development and Testing
$ git clone https://github.com/makenew/pypackage.git $ cd pypackage $ pipenv install --dev
Run each command below in a separate terminal window:
$ make watch
Primary development tasks are defined in the Makefile.
The source code_ is hosted on GitHub. Clone the project with
$ git clone https://github.com/makenew/pypackage.git
Install the development dependencies with
$ pipenv install --dev
Lint code with
$ make lint
Run tests with
$ make test
Run tests on chages with
$ make watch
Use the bumpversion command to release a new version. Push the created git tag which will trigger a CircleCI publish job.
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.
- CODECOV_TOKEN: Codecov token for uploading coverage reports (optional).
These may be set manually or by running the script ./circleci/envvars.sh.
Please submit and comment on bug reports and feature requests.
To submit a patch:
- Fork it (https://github.com/makenew/pypackage/fork).
- Create your feature branch (git checkout -b my-new-feature).
- Make changes.
- 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 Python package is licensed under the MIT license.
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.
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|
|makenew_pypackage-1.0.3-py3-none-any.whl (5.2 kB) Copy SHA256 hash SHA256||Wheel||py3|
|makenew-pypackage-1.0.3.tar.gz (4.6 kB) Copy SHA256 hash SHA256||Source||None|