aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoel Eager <jee7291@rit.edu>2018-10-07 19:40:38 -0400
committerJoel Eager <jee7291@rit.edu>2018-10-07 19:40:38 -0400
commita24b9bcb35286be1ad3b174d9c913de25652b735 (patch)
treeaa76940f784725f2f43dc26f9708e55e7ac5db41 /README.md
parente1431d366fcda3e67845a5040f77f2928a047cd0 (diff)
Documented usage in the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 22 insertions, 27 deletions
diff --git a/README.md b/README.md
index ad2c6ba..a25dac7 100644
--- a/README.md
+++ b/README.md
@@ -54,38 +54,33 @@ To switch between OIDC realms you'll need to set the modify the following values
By default `OIDC_ISSUER` and `REALM` are configured for the CSH members realm.
-Authorization
--------------
-
-Authentication happens via pyOIDC with CSH SSO, authenticating as the user who is viewing the page.
-We have two different realms, and the site changes depending which realm is in use.
-
-The server uses heavy caching via lru_cache to speed up the results as much as possible
-
-Setup
-------
-
-For local development setup follow these steps:
+## Usage
+To run packet using the flask dev server use this command:
+```bash
+python3 wsgi.py
+```
+The Flask debug mode flag can be set using via the config system explained above.
-1. ```pip install -r requirements.txt```
-2. `Create config.py` or set environment variables
- - Several of these variables require keys and information, please reach out to an RTP for testing information
-3. Run `wsgi.py`
+Alternative you can run it through [gunicorn](https://gunicorn.org/) using this command:
+```bash
+gunicorn -b :8000 packet:app --access-logfile -
+```
+### CLI
+Packet makes use of the Flask CLI for exposing functionality to devs and admins. This is primarily designed to be used
+locally with the target DB set via the server's config values.
-Commands
---------
+To use the CLI just set the project up as normal and then run the `flask` command in the project's root directory.
+It'll automatically load up the app and show you a list of available commands. For more details on a particular command
+use the help flag like this:
+```bash
+flask {command} --help
+```
-The flask CLI provides all the methods needed to setup a packet and a packet season
+**WARNING:** Be sure to double check which DB you're pointed at when using one of the admin or DB commands.
-```
- create-packets Creates a new packet season for each of the freshmen in the given CSV.
- create-secret Generates a securely random token.
- db Perform database migrations.
- ldap-sync Updates the upper and misc sigs in the DB to match ldap.
- sync-freshmen Updates the freshmen entries in the DB to match the given CSV.
- fetch-results Fetches and prints the results from a given packet season.
-```
+All DB commands are from the `Flask-Migrate` library and are used to configure DB migrations through Alembic. See their
+docs [here](https://flask-migrate.readthedocs.io/en/latest/) for details.
Code Standards
------------