Package skeleton for a python module.
Project description
Package skeleton for an Python module.
Description
Bootstrap a new Python package in less than a minute.
Features
Publishing to PyPI.
Secure dependency management with Poetry.
Linting with Pylint.
pytest helps you write better programs.
Code coverage reporting with Codecov.
CircleCI ready.
Consistent coding with EditorConfig.
Badges from Shields.io.
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
Run
$ ./makenew.sh
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
$ .circleci/envvars.sh
Review, commit, and push the changes to GitHub with
$ git diff --cached $ git commit -m "Replace makenew boilerplate" $ git remote add origin git@github.com:<user>/<new-python-package>.git $ git push -u origin master
Ensure the CircleCI build passes, then publish the initial version of the package with
$ cat pyproject.toml | grep 'python = ".*"' | cut -d '"' -f 2 > .python-version $ pyenv install $(cat .python-version) $ pyenv virtualenv $(cat .python-version) $(basename $(pwd)) $ echo $(basename $(pwd)) > .python-version $ pyenv activate $ poetry install $ poetry run bumpversion patch $ git push $ git push --tags
Updating
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 git@github.com:makenew/pypackage.git
You can then fetch and merge changes with
$ git fetch --no-tags 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_pypackage.
Install it with
$ poetry install makenew_pypackage
Development and Testing
Quickstart
$ git clone https://github.com/makenew/pypackage.git $ cd pypackage $ cat pyproject.toml | grep 'python = ".*"' | cut -d '"' -f 2 > .python-version $ pyenv install $(cat .python-version) $ pyenv virtualenv $(cat .python-version) $(basename $(pwd)) $ echo $(basename $(pwd)) > .python-version $ pyenv activate $ poetry install
Run each command below in a separate terminal window:
$ make watch
Primary development tasks are defined in the Makefile.
Source Code
The source code is hosted on GitHub. Clone the project with
$ git clone https://github.com/makenew/pypackage.git
Requirements
You will need Python 3 with pyenv and Poetry.
Install Python and create and use a new virtualenv (if one does not yet exist) with
$ cat pyproject.toml | grep 'python = ".*"' | cut -d '"' -f 2 > .python-version $ pyenv install $(cat .python-version) $ pyenv virtualenv $(cat .python-version) $(basename $(pwd)) $ echo $(basename $(pwd)) > .python-version $ pyenv activate
Install the development dependencies with
$ poetry install
Tests
Lint code with
$ make lint
Run tests with
$ make test
Run tests on chages with
$ make watch
Publishing
Use the bumpversion command to release a new version. Push the created git tag which will trigger a CircleCI publish job.
CircleCI Setup
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.
Contributing
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.
License
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_pypackage-2.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed2bd0bdeff7b26cc64b3441cfa110591b69d0b7e1a933d9aff34feed0e60ec3 |
|
MD5 | f0817f3d3b1d54ab7867f1136b971728 |
|
BLAKE2b-256 | 390389c8708824a5a62740ecc6772e92de2978a03e0ed46c30de7390228796b1 |