pk/atst

Brian Duggan a340eede07 Config, secrets, basic POST handling

* add script/config
  * add atst.ini
  * add cookie_secret
  * update docs

2018-06-14 13:52:11 -04:00

1.4 KiB

Raw Blame History

ATST

Installation

script/setup

The setup script installs pipenv, which is what this application uses to manage its dependences and virtualenv. Instead of the classic requirements.txt file, pipenv uses a Pipfile and Pipfile.lock, making it more similar to other modern package managers like yarn or mix.

To enter the virtualenv manually (a la source .venv/bin/activate):

pipenv shell

If you want to automatically load the virtual environment whenever you enter the project directory, take a look at direnv. An .envrc file is included in this repository. direnv will activate and deactivate virtualenvs for you when you enter and leave the directory.

Configuration

A sample configuration is included in atst.ini.example.

cp atst.ini.example atst.ini

Be sure to modify it and change the 'secret' key.

script/config (called by script/setup) will provide a default configuration.

Running (development)

To start the app and watch for changes:

DEBUG=1 script/server

Testing

To run unit tests:

script/test

python -m pytest

Notes

tornado templates are like mustache templates -- add the following to ~/.vim/filetype.vim for syntax highlighting:

:au BufRead *.html.to set filetype=mustache

1.4 KiB Raw Blame History