This API allows you to interact with data related to SendGrid's Dev Rel (Developer Relations) KPIs (Key Performance Indicators). The goal is to make this code general enough for usage by any Developer Relations team.
- Clone this repo
virtualenv venv
# initialize a virtual environment. ./activate.sh
# to activate the virtual environmentpip install -r requirements.txt
# install the dependencies- rename
.env_sample
to.env
and update the credentials - make manage.py executable, then
./manage.py runserver
# execute the program
To cleanup your local directory run .cleanup.sh
The documentation is located on Apiary. The source file for the documentation is in apiary.apib. To utilize that source file, sign up for a free Apiary.io account. For offline testing, see Dredd.
./manage.py test
# run the tests in the tests folder