An opinionated Python packaging template generator.
pypk autogenerates a complete python package skeleton that is installable out of the box. It assumes the following tools are used in your development workflow:
| Tool | Description |
|---|---|
| pip | The PyPA recommended tool for installing Python packages. |
| pip-tools | A set of tools to keep your pinned Python dependencies fresh. |
| bandit | A tool to find common security issues in Python code. |
| black | The uncompromising Python code formatter. |
| flake8 / flake8-bugbear | Glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality / A plugin for Flake8 finding likely bugs and design problems in your program. |
| isort | A Python utility / library to sort imports. |
| pre-commit | A framework for managing and maintaining multi-language pre-commit hooks. |
| pytest | The Python testing framework. |
| safety | Checks your installed dependencies for known security vulnerabilities. |
However, once the template is generated, pypk gets out of your way, so you are free to add and/or remove tools, frameworks, and libraries as needed.
pip install pypk
It's recommended you install and use pypk in the same virtual environment you plan to develop your Python package in.
To create a new skeleton project, run the create command:
pypk create </path/to/project/root> -a <author-name> -e <author-email>Additionally, you can pass the following arguments:
-c/--config: a json config file (see the Configuration section).-d/--description: set the package description in the generatedsetup.py-p/--py-version: set the minimum Python version supported by the project.--init-git/--skip-git-init: initialize git in the generated project (or skip it).--create-tests-dir/--skip-tests-dir: create a top level tests directory in the generated project (or skip it).
Run pypk create --help for more details.
pypk supports a configuration which holds (default) parameters for project creation. Specifically, the following parameters can be set in a json config file:
author(key=author)email(key=email)description(key=description)py-version(key=py_version)init-git(key=init_git)create-tests-dir(key=tests_dir)
Additionally, default values can be set via the cli so they do not need to be specified whenver the create command is
run. pypk will create a json file under the user config dir as defined by appdirs.
To set a value, run the following:
pypk config <key> <value>To print out the currently set value, run:
pypk config <key>MIT