Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.51 KB

README.rst

File metadata and controls

108 lines (73 loc) · 3.51 KB
Raw

https://raw.githubusercontent.com/websauna/cookiecutter-websauna-app/master/logo/logo-150.png

Cookiecutter template to create a Websauna Application.

ci License Supported Python versions Latest Version

Features

  • Websauna: Support to the latest version.
  • Virtualenv automatically created and setup in development mode.
  • Travis-CI: Ready for Travis Continuous Integration testing.
  • Tox testing: Setup to easily test for Python 3.5 and above.

Usage

To generate a new Websauna application package, first install Cookiecutter:

$ pip install cookiecutter

Now run it against this repo:

$ cookiecutter gh:websauna/cookiecutter-websauna-app

You'll be prompted for some values. Provide them, then a Websauna application will be created for you.

Warning: After this point, change 'Amazing Team', 'websauna', etc to your own information.

Answer the prompts with your own desired options. For example:

full_name [Amazing Team]: Amazing Team
email [[email protected]]: [email protected]
company [Websauna]: Company
github_username [websauna]: company
project_name [My Package]: My Application
project_short_description [A nice and short description.]: Another Websauna application
tags [python package websauna pyramid]: python package websauna pyramid
repo_name [my.app]: company.application
namespace [my]: company
package_name [app]: application
release_date [today]:
year [2017]:
version [1.0.0a1]:
Select create_virtualenv:
1 - True
2 - False
Choose from 1, 2 [1]: 1

After a while, the generation will be finished and the following message will be displayed:

===============================================================================
Websauna Application.
Package my.app was generated.
Now, code it, create a git repository, push to your GitHub account.
To deploy this Websauna package with Ansible, use the following variables

    - package_name: my.app
    - package_path: my/app

Read more about Websauna deployment:
  https://websauna.org/docs/tutorials/deployment/index.html

Sorry for the convenience.
===============================================================================

Next Steps

  • Code the package
  • Create a git repository
  • Push to GitHub (or any other platform)