-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
46 lines (35 loc) · 2.07 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Usage:
First you need to install virtualenv and create a virtualenv in your filesystem
- cd /path/to/my/virtualenv
- source ./bin/active #Optional, but sets your path to be that of the virtualenv
- easy_install pip #Optional again, but pip is generally more used
- pip install pyramid
- cd /path/to/this/directory
- python setup.py install # or pip install .
- pcreate my_project_name -s alchemy_auth
- cd my_project_name
Once the project is created, you then need to install it into your virtualenv
- python setup.py develop # or pip install -e .
Then install necessary libraries
- pip install -r requirements/python2.txt # or replace with your own
OR for python 3 users
- pip install -r requirements/python3.txt
You can and should replace this with your own requirements.txt
Next, initialize the database
- initialize_my_project_name_db
This will create a postgresql database and create the necessary tables, along
with the corresponding alembic migrations
Your application should now be ready.
- pserve development.ini --reload
What is in this project that's not in the normal alchemy scaffold?
This is a very personalized scaffold so in the future I can skip a number of basic steps when starting up a new project. Changes over the alchemy scaffold include:
- Installation and implementation of authentication with pyramid_beaker. There are a few bare bones .html.mako templates showing the authentication working
- Installation of alembic (and changing revision filenames to be the create time rather than hexes)
- Default to postgres instead of sqlite. initializedb script also simply creates the database for you, with no added fluff
- MyModel is removed. The only models present are User and UserSession for beaker. The base model also includes id as a UUID, and create/modify timestamps
- my_view is removed, and replaced with authentication views
- The dummy tests have been removed
TODO items:
- Include a requirements.txt file. Ideally it should be generated from pip freeze after the project has been generated.
- Set up sqlalchemy session pooling
- Set up a testing suite with nosetests