Skip to content

Latest commit

 

History

History
144 lines (106 loc) · 4.33 KB

README.md

File metadata and controls

144 lines (106 loc) · 4.33 KB

Bookmark Manager Services

The Bookmark Manager Services consist of a Postgres database and a Python application supporting a REST API used by the internal and user-facing Presterity web clients.

Development

Requirements

Get the repo set up

  1. Install git, Python 3, and virtualenv.

  2. Install Python Postgres adapter

sudo apt-get install libpq-dev python3-dev

  1. Get set up to connect to github with ssh

  2. Create virtual environment and clone bookmarks repo:

cd ~/projects
virtualenv --python python3 --prompt presterity- venvs/presterity
source venvs/presterity/bin/activate
git clone git@github.com:presterity/bookmarks
pip install -r requirements.txt

(optional) Set up the project in PyCharm

If you use PyCharm as your IDE, this section will show you how to set up the project.

  1. Open your project in PyCharm
  2. Tell PyCharm about the virtual environment you just created by following these instructions
  3. Tell PyCharm where to look for modules within your project. Right-click on the server/ directory in the project explorer and select Mark Directory as -> Sources Root

Now whenever you add a new module to the project or install a new dependency into your virtual environment, PyCharm will know about it.

Set up your database

  1. Install Postgres (Ubuntu 14.04)

  2. Create super user for yourself:

sudo -i -u postgres
createuser --interactive
Enter name of role to add: <username>
Shall the new role be a superuser? (y/n) y
createdb <username>
  1. Create local presterity schema and user/role:
psql
postgres=# create database presterity;
postgres=# \c presterity;
postgres=# create schema apps;
postgres=# create user app_user with password 'resist';
postgres=# alter role app_user set search_path to apps;
postgres=# grant all on schema apps to app_user;
  1. Connect to presterity database as app_user user and populate apps schema:
psql -U app_user -d presterity -h localhost 
presterity => \conninfo
You are connected to database "presterity" as user "app_user" on host "127.0.0.1" at port "5432"
SSL connection (cipher: DHE-RSA-AES256-GCM-SHA384, bits: 256)
presterity => \i sql/001-bookmark-schema.sql;
CREATE FUNCTION
psql:sql/001-bookmark-schema.sql:14: NOTICE:  table "bookmark" does not exist, skipping
DROP TABLE
CREATE TABLE
CREATE TRIGGER
psql:sql/001-bookmark-schema.sql:58: NOTICE:  table "bookmark_topic" does not exist, skipping
DROP TABLE
CREATE TABLE
CREATE INDEX
CREATE TRIGGER
psql:sql/001-bookmark-schema.sql:78: NOTICE:  table "bookmark_note" does not exist, skipping
DROP TABLE
CREATE TABLE
CREATE INDEX
CREATE TRIGGER
presterity => \dt
              List of relations
 Schema |      Name      | Type  |   Owner    
--------+----------------+-------+------------
 apps   | bookmark       | table | app_user
 apps   | bookmark_note  | table | app_user
 apps   | bookmark_topic | table | app_user
(3 rows)
  1. Alternatively, use mschematool to populate apps schema:
export MSCHEMATOOL_CONFIG=/ws/git/presterity/bookmarks/migration.py 
mschematool local init_db
mschematool local to_sync
mschematool local sync

Testing

Run the unit tests

python -m unittest discover -v bookmarks

Running the Bookmark Manager service

The Bookmark Manager is a web service, currently implemented in Flask. To run, start your Python 3 virtualenv, and from the bookmarks repo root, run

python ./server/run.py

To verify that the server is running, go to http://localhost:8080/ in a browser or hit it with curl. It should respond 'OK'

curl http://localhost:8080/