https://github.com/karantan/websauna-cookiecutter-addon
https://github.com/karantan/websauna-cookiecutter-addon
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/karantan/websauna-cookiecutter-addon
- Owner: karantan
- Created: 2016-12-08T13:33:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-09T13:42:28.000Z (over 8 years ago)
- Last Synced: 2025-02-13T15:53:51.693Z (4 months ago)
- Language: Python
- Size: 24.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
=============================
websauna-cookiecutter-addon
=============================
A cookiecutter (project template) for creating a Websauna addon project.
Requirements
------------
* See websauna `requirements `_
Usage
-----
1. Generate a Websauna project.
.. code-block:: bash
$ ws-create --app websauna_addon
2. Finish configuring the project by creating a virtual environment and
installing your new project.
See detailed instructions on the official Websauna
`documentation `_.
Contributing
------------
1. Create virtualenv and install tox.
.. code-block:: bash
$ virtualenv -p python3 venv
$ pip install tox
2. Run all the tests:
.. code-block:: bash
$ tox
3. Add your changes and tests, run tests and create PR.