Package skeleton for a python app.
Project description
Package skeleton for an Python app.
Description
Bootstrap a new Python app in less than a minute.
Features
Publishing to PyPI.
Secure dependency management with Poetry.
Alpine Linux based multi-stage Docker builds for optimized production images.
Images tagged using package version and commit checksum.
Images pushed to Docker Hub, Heroku, Bintray and the Amazon EC2 Container Registry (ECR).
Standardized JSON logging with structlog.
Centralized dependency injection with pinject.
Tornado with asyncio.
Linting with Pylint.
pytest helps you write better programs.
Code coverage reporting with Codecov.
Continuous unit and smoke testing and deployment with CircleCI.
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 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-app>.git $ git push -u origin master
Ensure the CircleCI build passes, then publish the initial version of the package with
$ 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/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 Docker Hub. 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" \ makenew/python-app
Installation
This package is also registered on the Python Package Index (PyPI) as makenew_python_app.
Install it with
$ poetry install 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 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: These may be set manually or by running the script ./.circleci/envvars.sh.
TWINE_USERNAME: Username for publishing on PyPI.
TWINE_PASSWORD: Password for publishing on PyPI.
CODECOV_TOKEN: Codecov token for uploading coverage reports (optional).
Codecov
If set, CircleCI will send code coverage reports to Codecov.
CODECOV_TOKEN: Codecov token for uploading coverage reports.
Docker Hub
If set, CircleCI will build, tag, and push images to Docker Hub.
DOCKERHUB_REPOSITORY: Docker Hub repository name.
DOCKERHUB_USERNAME: Docker Hub username.
DOCKERHUB_PASSWORD: Docker Hub password.
Bintray
If set, CircleCI will build, tag, and push images to Bintray.
BINTRAY_REGISTRY: Bintray registry name.
BINTRAY_REPOSITORY: Bintray repository name.
BINTRAY_USERNAME: Bintray username.
BINTRAY_PASSWORD: Bintray password (your API key).
Amazon EC2 Container Registry (ECR)
If set, CircleCI will build, tag, and push images to Amazon ECR.
AWS_ECR_REPOSITORY: Amazon ECR repository name.
AWS_ACCOUNT_ID: Amazon account ID.
AWS_DEFAULT_REGION: AWS region.
AWS_ACCESS_KEY_ID: AWS access key ID.
AWS_SECRET_ACCESS_KEY: AWS secret access key.
Heroku
If set, CircleCI will deploy images built from master directly to Heroku.
HEROKU_APP: Heroku application name.
HEROKU_TOKEN: Heroku authentication token.
Docker
The production Docker image is built on CircleCI from .circleci/Dockerfile: this Dockerfile can only be used with the CircleCI workflow.
In rare cases, building an equivalent container locally may be useful. Build and run this local container with
$ docker build -t makenew/python-app . $ docker run --read-only --init --publish 80:8080 makenew/python-app
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.
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_python_app-0.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 09fcf41fb95e03cf24d081bfc032d2e22e17c8761cd8d0ed50c81799549040ce |
|
| MD5 | 06ba8351bdf5552eff265fe991602e1d |
|
| BLAKE2b-256 | 25e529a91c6f65ae2dfa7be93cfad8b4f0f3f33c7211a3d7fe1b31da054b1256 |
