Tool that helps in the creation of python projects.
- Install via executable, pip, or local development
- Run the executable
PythonProjectBootstrapper creates a python project that adheres to modern best practices for python package development. It also generates Continuous Integration / Delivery / Deployment workflows that maximize the free functionality offered by GitHub for open-source solutions.
- Simple local development through
Build.py(see Local Development for more information) - Python bootstrapping via PythonBootstrapper
- Source code formatting via black
- Static source analysis via pylint
- Test execution via pytest
- Code coverage extraction via coverage
- Semantic version generation via AutoGitSemVer
- Python wheel creation
- Wheel deployment to PyPi
- Executable generation via cx_Freeze
- Full Continuous Integration, Continuous Delivery, and Continuous Deployment (via GitHub Actions) for everything listed above
- [Optional] Build artifact signing via Minisign
- [Optional] Participation in the Open Source Security Foundation (OpenSSF) Best Practices Badge Program
- [Optional] Generation of development environment docker images in support of FAIR principles
Please see DEVELOPMENT.md for information on the generated content and how to make common modifications to that content.
From a terminal window, run one of the commands below. You will be asked a series of questions when generating a python project, then guided through configuration activities to ensure that the project is ready for use.
| Scenario | Command Line | Output |
|---|---|---|
| Create a project for a python package | PythonProjectBootstrapper package <output_dir> |
┌──────────────────────────────────────────────────────────────────────────────── Python Package ─────────────────────────────────────────────────────────────────────────────────┐ │ │ │ This project creates a Python package hosted on GitHub that uploads a Python wheel to PyPi. It also includes opt-in functionality to create docker images that ensure the exact │ │ reproducibility of all commits (which is especially useful for scientific software). │ │ │ │ If you continue, you will be asked a series of questions about your project and given step-by-step instructions on how to set up your project so that it works with 3rd party │ │ solutions (GitHub, PyPi, etc.). │ │ │ │ The entire process should take about 20 minutes to complete. │ │ │ └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ Enter 'yes' to continue or 'no' to exit: |
| Display Help | PythonProjectBootstrapper --help |
Usage: PythonProjectBootstrapper [OPTIONS] PROJECT:{package} OUTPUT_DIR
┌─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ * project PROJECT:{package} Project to build. [default: None] [required] │
│ * output_dir DIRECTORY Directory to populate. [default: None] [required] │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
┌─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ --configuration-filename FILE Filename that contains template configuration values; see │
│ https://cookiecutter.readthedocs.io/en/stable/advanced/user_config.html for more info. │
│ [default: None] │
│ --replay Do not prompt for input, instead read from saved json. │
│ --yes Answer yes to all prompts. │
│ --version Display the current version and exit. │
│ --install-completion [bash|zsh|fish|powershell|pwsh] Install completion for the specified shell. [default: None] │
│ --show-completion [bash|zsh|fish|powershell|pwsh] Show completion for the specified shell, to copy it or customize the installation. [default: None] │
│ --help Show this message and exit. │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
|
| Version | PythonProjectBootstrapper --version |
PythonProjectBootstrapper v0.2.0 |
Download an executable for Linux, MacOS, or Windows to use the functionality provided by this repository without a dependency on Python.
- Download the archive for the latest release here; the files will begin with
exe.and contain the name of your operating system. - Decompress the archive
Install the PythonProjectBootstrapper package via pip (Package Installer for Python) to use it with your python code.
pip install PythonProjectBootstrapper
Follow these steps to prepare the repository for local development activities.
-
Clone this repository
-
Bootstrap the local repository by running...
Operating System Command Linux / MacOS Standard:
Bootstrap.shStandard + packaging:
Bootstrap.sh --packageWindows Standard:
Bootstrap.cmdStandard + packaging:
Bootstrap.cmd --package -
Activate the development environment by running...
Operating System Command Linux / MacOS . ./Activate.shWindows Activate.cmd -
Invoke
Build.pyCommand Description Example Notes blackValidates that the source code is formatted by black. Validation:
python Build.py blackPerform formatting:
python Build.py black --formatpylintValidates the source code using pylint. python Build.py pylintpytestRuns automated tests using pytest. Without Code Coverage:
python Build.py pytestWith Code Coverage:
python Build.py pytest --code-coverageupdate_versionUpdates the semantic version of the package based on git commits using AutoGitSemVer. python Build.py update_versionpackageCreates a Python wheel package for distribution; outputs to the /distdirectory.python Build.py packageRequires --packagewhen bootstrapping in step #2.publishPublishes a Python wheel package to PyPi. https://test.pypi.org:
python Build.py publishhttps://pypi.org:
python Build.py publish --productionRequires --packagewhen bootstrapping in step #2.build_binaryBuilds an executable for your package that can be run on machines without a python installation; outputs to the /builddirectory.python Build.py build_binaryRequires --packagewhen bootstrapping in step #2. -
[Optional] Deactivate the development environment by running...
Operating System Command Linux / MacOS . ./Deactivate.shWindows Deactivate.cmd
There are other tools available that offer similar functionality, each emphasizing different domains, conventions, or workflows. They are listed here in the event that one of them is a better fit for the specifics of your scenario.
| Tool | Description |
|---|---|
| Scientific Python: guide, cookie, & sp-repo-review | A copier/cookiecutter template for new Python projects based on the Scientific Python Developer Guide. |
| cookiecutter-cms | A cookiecutter template for those interested in developing computational molecular packages in Python. |
| LINCC Frameworks Python Project Template | This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation. |
| Cookiecutter Django | Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly. |
| cookiecutter-pylibrary | Enhanced cookiecutter template for Python libraries. |
PythonProjectBootstrapper uses cookiecutter as its underlying templating engine, but others are available within python. Some are listed here if you want to use them directly.
| Tool | Description |
|---|---|
| cookiecutter | A cross-platform command-line utility that creates projects from cookiecutters (project templates), e.g. Python package projects, C projects. |
| copier | A library and CLI app for rendering project templates. |
PythonProjectBootstrapper is licensed under the MIT license.
