Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.7 KB

README.rst

File metadata and controls

47 lines (33 loc) · 1.7 KB
Raw

cookiecutter

cookiecutter is a python utility by @audreyr to create python skeleton for new Python apps

cookiecutter-appbase

cookiecutter-appbase a application boilerplate for scroll style Python apps.

What does it do?

It builds envioronment for common scroll python project requirements

For example if we are creating a new project with the name Our New App and slug is our_new_app ..

  • It copies files directories in {{cookiecutter.project_slug}} directory to our_new_app
  • It has ability to use variables declared in cookiecutter.json in naming file/directory names and in template.
    • eg. {{cookiecutter.project_slug}} directory will be renamed our_new_app
    • any files with text {{cookiecutter.}} will be replaced with it's corresponding value defined in cookiecutter.json

Usage instructions for creating new projects

pip install cookiecutter
cookiecutter git@github.com:scrolltech/cookiecutter-appbase.git
cd <app dir>
pip install -r requirements.txt
gunicorn service:__hug_wsgi__

# verify
firefox http://127.0.0.1:8000/echo/hello-world

Guide for creating new project boilerplate like this one

I couldn't quickly figure out cookiecutter inspite of it's simplicity and good documentation. So here are some notes

  • pip install cookiecutter
  • Fork github.com/audreyr/cookiecutter-pypackage
  • Rename cookiecutter-appbase
  • git clone git@github.com:<gituser>/cookiecutter-appbase.git
  • vi cookiecutter.json