/pyramid-cookiecutter-zodb

[DEPRECATED - Please use https://github.com/pylons/pyramid-cookiecutter-starter instead] A Cookiecutter (project template) for creating a Pyramid project using ZODB for persistent storage, traversal for routing, and Chameleon for templating.

Primary LanguagePython

pyramid-cookiecutter-zodb

Deprecation notice

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 pyramid-cookiecutter-alchemy and pyramid-cookiecutter-zodb. Please use pyramid-cookiecutter-starter instead of this one. This cookiecutter may not receive further updates.

latest Travis CI Status

A Cookiecutter (project template) for creating a Pyramid project using ZODB for persistent storage, traversal for routing, and Chameleon for templating.

Requirements

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.
  • master aligns with the master 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-zodb

    Optionally append a specific branch checkout to the command:

    $ cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout master
  2. 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]"
  3. Run your project's tests.

    $ env/bin/pytest
  4. Run your project.

    $ env/bin/pserve development.ini