https://github.com/pylons/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.
https://github.com/pylons/pyramid-cookiecutter-zodb
chameleon cookiecutter-template pyramid traversal zodb
Last synced: about 2 months ago
JSON representation
[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.
- Host: GitHub
- URL: https://github.com/pylons/pyramid-cookiecutter-zodb
- Owner: Pylons
- Created: 2016-06-02T19:08:13.000Z (almost 9 years ago)
- Default Branch: latest
- Last Pushed: 2018-10-31T06:20:18.000Z (over 6 years ago)
- Last Synced: 2024-05-02T00:42:09.784Z (about 1 year ago)
- Topics: chameleon, cookiecutter-template, pyramid, traversal, zodb
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 3
- Watchers: 9
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.txt
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
=========================
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.
.. image:: https://travis-ci.org/Pylons/pyramid-cookiecutter-zodb.png?branch=latest
:target: https://travis-ci.org/Pylons/pyramid-cookiecutter-zodb
:alt: 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
------------
* Python 2.7 or 3.4+
* `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.
* ``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.
.. code-block:: bash
$ cookiecutter gh:Pylons/pyramid-cookiecutter-zodb
Optionally append a specific branch checkout to the command:
.. code-block:: bash
$ 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.
.. code-block:: bash
# 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.
.. code-block:: bash
$ env/bin/pytest
4. Run your project.
.. code-block:: bash
$ env/bin/pserve development.ini