.. image:: https://github.com/Pylons/pyramid-cookiecutter-starter/workflows/Build%20and%20test/badge.svg?branch=latest :target: https://github.com/Pylons/pyramid-cookiecutter-starter/actions?query=branch%3Alatest :alt: Latest Branch Status
A Cookiecutter (project template) for creating a Pyramid starter project.
Customizable options upon install include choice of:
cookiecutter <https://cookiecutter.readthedocs.io/en/latest/installation.html>
_This cookiecutter has several branches to support new features in Pyramid or avoid incompatibilities.
latest
aligns with the latest stable release of Pyramid, and is the default branch on GitHub.main
aligns with the main
branch of Pyramid, and is where development takes place.x.y-branch
aligns with the x.y-branch
branch of Pyramid... code-block:: bash
$ cookiecutter gh:Pylons/pyramid-cookiecutter-starter
Optionally append a specific branch checkout to the command:
.. code-block:: bash
$ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout main
These steps are output to the console and are written to the file in ``<my_project>/README.txt`` by the cookiecutter, and are slightly different for Windows.
.. code-block:: bash
# Change directory into your newly created project if not already there. Your
# current directory should be the same as this README.txt file and setup.py.
$ cd <my_project>
# Create a Python virtual environment, if not already created.
$ python3 -m venv env
# Upgrade packaging tools.
$ env/bin/pip install --upgrade pip setuptools
# Install the project in editable mode with its testing requirements.
$ env/bin/pip install -e ".[testing]"
# The previous step installs the latest stable release of Pyramid.
# Optionally install a specific version of Pyramid.
# For example, the unreleased version of the main branch:
env/bin/pip install -e git+https://github.com/pylons/pyramid.git@main#egg=pyramid
sqlalchemy
as a backend, there will be additional steps in the output and README.txt
... code-block:: bash
$ env/bin/pytest
.. code-block:: bash
$ env/bin/pserve development.ini