LeStarch / cookiecutter-python

A cookiecutter for Python 3.6+ projects

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

cookiecutter-python

CI Status

A Cookiecutter template for Python 3.6+ projects

Usage

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.6.0 or higher):

pip install -U cookiecutter

Generate a Python package project:

cookiecutter https://github.com/digitalr00ts/cookiecutter-python.git

Features

  • tox
  • pylint
  • pytest
  • bandit
  • coverage
  • editorconfig
  • gitignore
    • python
    • vim
    • vscode
    • InteliJ
  • License (Apache 2.0)
  • Python Packaging
  • Readme
  • Pipfile
  • gitattributes
  • Black formater
  • Travis
  • versioning from git tag
  • cli w/ docopt
  • use package as module

To Do

  • Add license options to template

    • Creative Commons Attribution
    • Creative Commons Zero
    • Creative Commons Attribution Share Alike
    • GNU Free Documentation License (FDL)
    • Public Documentation License (PDL)
    • FreeBSD Documentation License
    • Open Publication License
  • add ability to select built-in theme for docs
  • Documentation
  • VCS Templates
    • Github
    • Gitlab
    • Gitea/Gogs ???
  • exceptions
  • CI/CD
    • Jenkins
    • Gitlab CI
  • License Options
  • testing
    • hypothosis
    • pytest-bdd
  • lint default cookiecutter template (testing)
  • logging
  • includes, Better Exceptions
  • precommit
  • testing
  • coverall
  • push to pypi

About

A cookiecutter for Python 3.6+ projects

License:Apache License 2.0


Languages

Language:Python 98.6%Language:Shell 1.4%