This cookiecutter has been deprecated in favor of the unified cookiecutter pyramid-cookiecutter-starter effective with the release of Pyramid 1.10.
pyramid-cookiecutter-starter combines all features of
Please use pyramid-cookiecutter-starter instead of this one.
This cookiecutter may not receive further updates.
A Cookiecutter (project template) for creating a Pyramid project using SQLite for persistent storage, SQLAlchemy for an ORM, Alembic for database migrations, URL dispatch for routing, and Jinja2 for templating.
- Python 2.7 or 3.4+
This cookiecutter has several branches to support new features in Pyramid or avoid incompatibilities.
latestaligns with the latest stable release of Pyramid, and is the default branch on GitHub.
masteraligns with the
masterbranch of Pyramid, and is where development takes place.
x.y-branchaligns with the
x.y-branchbranch of Pyramid.
Generate a Pyramid project, following the prompts from the command.
$ cookiecutter gh:Pylons/pyramid-cookiecutter-alchemy
Optionally append a specific branch checkout to the command:
$ cookiecutter gh:Pylons/pyramid-cookiecutter-alchemy --checkout master
Finish configuring the project by creating a virtual environment and installing your new project. These steps are output as part of the cookiecutter command above and are slightly different for Windows.
# Change directory into your newly created project. $ cd myproj # Create a virtual environment... $ python3 -m venv env # ...where we upgrade packaging tools... $ env/bin/pip install --upgrade pip setuptools # ...and into which we install our project and its testing requirements. $ env/bin/pip install -e ".[testing]"
Initialize and upgrade the database using Alembic.
# Generate your first revision. $ env/bin/alembic -c development.ini revision --autogenerate -m "init" # Upgrade to that revision. $ env/bin/alembic -c development.ini upgrade head
Load default data into the database using a script.
$ env/bin/initialize_tutorial_db development.ini
Run your project's tests.
Run your project.
$ env/bin/pserve development.ini