Pylons / pyramid-cookiecutter-starter

A Cookiecutter (project template) for creating a Pyramid starter project with choices for template language (Jinja2, Chameleon, or Mako), persistent backend (none, SQLAlchemy with SQLite, or ZODB), and mapping of URLs to routes (URL dispatch or traversal)

pyramid-cookiecutter-starter

A Cookiecutter (project template) for creating a Pyramid starter project.

Customizable options upon install include choice of:

• template language (Jinja2, Chameleon, or Mako)
• persistent backend (none, SQLAlchemy with SQLite, or ZODB)
• mapping of URLs to routes (if the selected persistent backend is "none" or "sqlalchemy" then URL dispatch, or if "zodb" then traversal)

Requirements

• Python 3.6+
• cookiecutter

Versions

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.

Usage

1. Generate a Pyramid project, following the prompts from the command.

   $ cookiecutter gh:Pylons/pyramid-cookiecutter-starter

   Optionally append a specific branch checkout to the command:

   $ cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout main

2. Create a virtual environment, upgrade packaging tools, and install your new project and its dependencies. 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.

   # 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

3. If you selected sqlalchemy as a backend, there will be additional steps in the output and README.txt.

4. Run your project's tests.

   $ env/bin/pytest

5. Run your project.

   $ env/bin/pserve development.ini