Python App Skeleton
Package skeleton for a Python app.
Description
Bootstrap a new Python app in less than a minute.
Features
Publishing to PyPI.
Secure dependency management with Poetry.
Multi-stage Docker builds for optimized production images.
Images tagged using package version and commit checksum.
Images pushed to GitHub Container Registry.
Standardized JSON logging with structlog.
Centralized dependency injection with pinject.
Tornado with asyncio.
Linting with Pylint.
Uncompromising code formatting with Black.
pytest helps you write better programs.
Code coverage reporting with Codecov.
Continuous unit and smoke testing and deployment with GitHub Actions.
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/python-app.git new-python-app $ cd new-python-app
Optionally, reset to the latest release with
$ git reset --hard <version-tag>
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 GitHub repository secrets
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-app>.git $ git push -u origin master
Ensure the GitHub action passes, then publish the initial version of the package with
$ poetry install $ poetry version patch $ make version
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/python-app.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.
Usage
Docker container
The service is distributed as a Docker container on GitHub Container Registry. To run locally, add configuration to config/local.json, then pull and run the image with
$ docker run --read-only --init --publish 8080:8080 \ --volume "$(pwd)/config/local.json:/usr/src/app/config/local.json" \ ghcr.io/makenew/python-app
Installation
This package is also registered on the Python Package Index (PyPI) as makenew-python-app.
Install it with
$ poetry add makenew-python-app
Development and Testing
Quickstart
$ git clone https://github.com/makenew/python-app.git $ cd python-app $ poetry install
Run each command below in a separate terminal window:
$ make watch $ make server
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/python-app.git
Requirements
You will need Python 3 and Poetry.
Install the development dependencies with
$ poetry install
Tests
Lint code with
$ make lint
Run tests with
$ make test
Run tests on changes with
$ make watch
Publishing
Use the poetry version command to release a new version. Then run make version to commit and push a new git tag which will trigger a GitHub action.
Publishing may be triggered using a version workflow_dispatch on GitHub Actions.
GitHub Actions
GitHub Actions should already be configured: this section is for reference only.
The following repository secrets must be set on GitHub Actions.
PYPI_API_TOKEN: API token for publishing on PyPI.
GH_USER: The GitHub user’s username to pull and push containers.
GH_TOKEN: A personal access token for the user.
These must be set manually.
Secrets for Optional GitHub Actions
The version and format GitHub actions require a user with write access to the repository including access to read and write packages. Set these additional secrets to enable the action:
GH_TOKEN: A personal access token for the user.
GIT_USER_NAME: The name to set for Git commits.
GIT_USER_EMAIL: The email to set for Git commits.
GPG_PRIVATE_KEY: The GPG private key.
GPG_PASSPHRASE: The GPG key passphrase.
Contributing
Please submit and comment on bug reports and feature requests.
To submit a patch:
Fork it (https://github.com/makenew/python-app/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 app 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.
1 maintainer
Metadata
1 maintainer
Release files for makenew-python-app 2.20.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| makenew-python-app-2.20.4.tar.gz | 12.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| makenew_python_app-2.20.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.0 kB
Release files / makenew-python-app-2.20.4.tar.gz
| Download URL | makenew-python-app-2.20.4.tar.gz |
|---|---|
| Size | 12.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
61c58d5595e2bf6ccd7c0b632eb42856fc80da7315ec428e01f6da041a56ed34
|
|
BLAKE2b-256 checksum How to use checksums |
664dd8cd5a8ecc296ca91d79d80f63d305d024d8229c34fbcb23384ee53e9a5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.8.10 Linux/5.15.0-1023-azure
|
Release files / makenew_python_app-2.20.4-py3-none-any.whl
| Download URL | makenew_python_app-2.20.4-py3-none-any.whl |
|---|---|
| Size | 10.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed40eb93b7925d7ae53b9dcf5f0df6468dad0897a61cdab03d0a7fb7e46a79af
|
|
BLAKE2b-256 checksum How to use checksums |
a65d7162dac409dc71dcb405a2821ebf8c01b82415c3ee32eec0cf32f7deee2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.8.10 Linux/5.15.0-1023-azure
|
Security for makenew-python-app 2.20.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
