olamyy/flask-extension-cookiecutter

A cookiecutter for writing flask extensions.

Flask Extension Cookiecutter

Cookiecutter template for writing flask extensions.

• GitHub repo: https://github.com/Olamyy/flask-extension-cookiecutter/
• Documentation: https://github.com/Olamyy/flask-extension-cookiecutter/blob/master/README.rst
• Free software: MIT license

Features

• Creating Main Extension Class
• Extension specific tests
• Testing setup with unittest and python setup.py test or py.test
• Travis-CI: Ready for Travis Continuous Integration testing
• Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3, 3.4, 3.5
• Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
• Bumpversion: Pre-configured version bumping with a single command
• Auto-release to PyPI when you push a new tag to master (optional)
• Command line interface using Click (optional)

Quickstart

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

pip install -U cookiecutter

Generate your extension by running:

cookiecutter https://github.com/Olamyy/flask-extension-cookiecutter/

Then:

• Create a repo and put it there.
• Add the repo to your Travis-CI account.
• Install the dev requirements into a virtualenv. (pip install -r requirements_dev.txt)
• Run the script travis_pypi_setup.py to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.
• Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook.
• Release your extension by pushing a new tag to master.

Not Exactly What You Want?

Check out

• mitsuhiko/flask-extension-wizard: is a wizard that also helps create flask extensions.

Or Submit a Pull Request

I also accept pull requests on this