.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :target: http://cookiecutter-birdhouse.readthedocs.org/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://github.com/bird-house/cookiecutter-birdhouse/actions/workflows/main.yml/badge.svg :target: https://github.com/bird-house/cookiecutter-birdhouse/actions/workflows/main.yml :alt: GitHub Workflows
.. image:: https://readthedocs.org/projects/cookiecutter-pypackage/badge/?version=latest :target: https://cookiecutter-pypackage.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://img.shields.io/github/license/bird-house/cookiecutter-birdhouse.svg :target: https://github.com/bird-house/cookiecutter-birdhouse/blob/master/LICENSE :alt: GitHub license
.. image:: https://badges.gitter.im/bird-house/birdhouse.svg :target: https://gitter.im/bird-house/birdhouse?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge :alt: Join the chat at https://gitter.im/bird-house/birdhouse
Cookiecutter_ template for a Python package.
A Cookiecutter template for a Birdhouse bird package
Cookiecutter_ is a command-line utility to create projects from templates. This cookiecutter-birdhouse template creates a barebones PyWPS server adhering to Birdhouse conventions.
It comes complete with a framework for installation, configuration, deployment, documentation and tests.
It even includes a Dockerfile for containerization!
Create your project then get started writing new WPS processes in minutes.
You may at any time update your project using the latest cookiecutter template using Cruft_.
.. warning::
This is the cookiecutter template for PyWPS without the Buildout deployment.
The template for the Buildout deployment is on branch 0.2.x_.
pytest and toxMakefile to install the code, start, stop, poll the server and morePrior to installing cookiecutter-birdhouse, the cookiecutter and cruft packages must be installed in your environment.
This is achieved via the following commands:
.. code-block:: console
$ python -m pip install cookiecutter
$ python -m pip install cruftWith cookiecutter and cruft installed, the cookiecutter-birdhouse template can be installed with:
.. code-block:: console
$ cruft create https://github.com/bird-house/cookiecutter-birdhouse.gitOnce cookiecutter clones the template, you will be asked a series of questions related to your project:
.. code-block:: console
full_name [Full Name]:
email [your@email]:
github_username [bird-house]:
project_name [Babybird]:
project_slug [babybird]:
project_repo_name [babybird]:
project_readthedocs_name [babybird]:
project_short_description [A Web Processing Service for Climate Data Analysis.]:
version [0.1.0]:
Select open_source_license:
1 - Apache Software License 2.0
2 - MIT license
3 - BSD license
4 - ISC license
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]:
http_port [5000]:
use_pytest [y]:
use_black [y]:
create_author_file [y]:The answer to all those questions are recorded in the .cruft.json file in
your generated bird.
After answering the questions asked during installation, a bird Python package will be created in your current working directory. This package will contain a configurable PyWPS service with some initial test processes.
Then:
For more details, see the cookiecutter-pypackage tutorial_.
See the babybird <http://babybird.rtfd.io/>_ example of a generated bird.
To keep the generated bird up-to-date with the cookiecutter template:
.. code-block:: console
$ cruft update # uses configurations in the .cruft.json fileCruft can be configured to ignore template changes to certain files, see https://cruft.github.io/cruft/#updating-a-project. Potential files to ignore:
See cruftskip example.
To link already generated project that was not initially generated using
cruft create:
.. code-block:: console
$ cruft link https://github.com/bird-house/cookiecutter-birdhouseThis will create the .cruft.json file so subsequently cruft update can
be used. You will need to answer the same questions as cruft create
above.
.. note::
After ``cruft link``, the ``commit`` field in the ``.cruft.json`` file will initially be wrong if you selected the default value.
To ensure a proper subsequent ``cruft update``, you need to edit the ``.cruft.json`` file and put the proper last commit of the cookiecutter used in that ``commit`` field.
See cruft_link_ example.If you want to extend the cookiecutter template then prepare your development environment as follows:
.. code-block:: console
$ git clone git@github.com:bird-house/cookiecutter-birdhouse.git
$ cd cookiecutter-birdhouse
$ conda env create -f environment.yml
$ source activate cookiecutter-birdhouse
$ make test
$ make bake
$ ls -l cookies/ babybird
$ make clean
Make a new version of this Cookiecutter in the following steps:
CHANGES.rst with the next version.bump-my-version bump --dry-run --verbose --new-version 0.3.1 patchbump-my-version bump --new-version 0.3.1 patchbump-my-version bump --new-version 0.4.0 minorgit push --tagsSee the bump-my-version_ documentation for details.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. Cruft: https://cruft.github.io/cruft/
.. cookiecutter-pypackage tutorial: https://cookiecutter-pypackage.readthedocs.io/en/latest/tutorial.html
.. _cruft_skip: https://github.com/bird-house/emu/commit/fb1ff9ffdf9e7f0282b36ff0727996cba3bf081a
.. _cruft_link: https://github.com/bird-house/finch/pull/128/commits/0b0d7f37966cbb5bf345dfd4b4ac7953f38f4867
.. _GitHub_Workflows: https://docs.github.com/en/actions/using-workflows
.. _Tox: http://testrun.org/tox/
.. _Sphinx: http://sphinx-doc.org/
.. _ReadTheDocs: https://readthedocs.io/
.. _bump-my-version: https://github.com/callowayproject/bump-my-version
.. _0.2.x: https://github.com/bird-house/cookiecutter-birdhouse/tree/0.2.x
.. _PyPI: https://pypi.python.org/pypi
.. _Mkdocs: https://pypi.org/project/mkdocs/