Skip to main content

Ultimate template for new Python 3 projects

Project description

Python 3 boilerplate template

docs build

As a freelancer I often require to do small projects on python. As any developer I do not like to do same boilerplate work each time, but I like to work in expected environment. So I decided to make this small project and include everything I often need in one place.

This project for small non-web projects.

Project is under development. Unreleased features available at master branch. Most fresh changes data available in CHANGELOG

Current project features

  • Readme file generation for new projects. Available formats: Markdown or reStructuredText
  • Authors file generation for new projects. Available formats: Markdown or reStructuredText
  • Changelog file generation for new projects. Available formats: Markdown or reStructuredText
  • License file generation for new projects. Generated as LICENSE in root folder and as reStructuredText in docs folder. Available licenses:
    • MIT
    • BSD-3
    • GNU GPL v3.0
    • Apache Software License 2.0
    • unlicensed (Public domain)
  • Sphinx doc folder and project generation. Configured for separated source and build folders.
  • setup.py and setup.cfg generation.
  • requirements.txt and requirements.dev generation based on template choices.

Usage

Single time usage example, requires installation of Cookiecutter:

cookiecutter https://github.com/insspb/py3-bp

Roadmap

  • Include pytest sample tests if pytest enabled
  • Include tox sample configuration files
  • Include nox sample configuration files
  • Include Alembic sample configuration files
  • Include Travis CI sample configuration files
  • Include Gitlab CI sample configuration files
  • Include AppVeyor CI sample configuration files

Currently this project is in 'I have an idea' stage.

Project python version

This project is developed and tested on python version 3.6 and python 3.7, but should work under any python 3.2+.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py3-bp-0.0.3.tar.gz (3.1 kB view details)

Uploaded Source

File details

Details for the file py3-bp-0.0.3.tar.gz.

File metadata

  • Download URL: py3-bp-0.0.3.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for py3-bp-0.0.3.tar.gz
Algorithm Hash digest
SHA256 29d5d24ae86e200c189662435d108798a974a06eb1d5987fea2dc433da5ae6c7
MD5 3ae73203a49634b84f625295b8abfb1d
BLAKE2b-256 c9671916561d06d52316f12290ddc65b1769b6c211eb6b2b0bc4460322331c7b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page