Nerevu API

Usage

1. Create and activate a virtual environment:

   Mac

   virtualenv env
   source env/bin/activate

   Windows

   virtualenv env
    ./env/Scripts/activate

2. Install requirements::

   pip install -r requirements.txt

3. Run the service:

   bin/sync-time

4. If you are contributing to this repo, install dev-requirements::

pip install -r dev-requirements.txt

Xero Setup

Your own Xero API account is required.

Headless Setup

https://sites.google.com/a/chromium.org/chromedriver/home

API Docs

• Timely
• Xero Projects

Configuration

Environment Variable	Description
API_SECRET	Flask App secret key
TIMELY_CLIENT_ID	Timely API client ID
TIMELY_SECRET	Timely API secret
XERO_CLIENT_ID	Xero API client ID
XERO_SECRET	Xero API secret

We use python-dotenv to manage environment variables. To access the values to the environment variables above, you need to create a symbolic link (symlink) to the .env file.

To create a symlink:

Windows

• Open a Command Prompt (right click and Run as Administrator)

• run the following code with the correct paths

  mklink "C:\{path_to_project}\\.env" "C:\{path_to_nerevu_dropbox}\Security\{username}\nerevu-api-env"

You can read more about symlinks here.

Linux

• Open a Terminal

• run the following code with the correct paths to create a soft link

  ln -s /{path_to_nerevu_dropbox}/Security/{username}/nerevu-api-env /{path_to_project}/.env

Chrome driver

Macports

sudo port install chromedriver

Homebrew

brew install chromedriver

Download

chromium.org