README.md

Ethodoxy API

Catholic Orthodoxy in electronic format

URLs

1. Site: http://chidimo.github.io/Ethodoxy/
2. API root: https://ethodoxy.herokuapp.com/api/v1
3. Swagger documentation: https://ethodoxy.herokuapp.com/swagger/

Available endpoints

1. https://ethodoxy.herokuapp.com/api/v1/versions/
2. https://ethodoxy.herokuapp.com/api/v1/books/
3. https://ethodoxy.herokuapp.com/api/v1/chapters/
4. https://ethodoxy.herokuapp.com/api/v1/verses/
5. https://ethodoxy.herokuapp.com/api/v1/commentary/

All API endpoint calls have a count key which tells the total number of results returned. The actual data is contained in the results key.

All results are paginated by 50 pages.

Recreating the database

It is possible to recreate the database on your local machine as the necessary .json files have been included in the drbo_data folder. The raw scrapped files are also available in the drbo_org_scrap folder.

1. Clone the repo

2. Run pipenv install and pipenv install --dev

3. Run python manage.py migrate

4. Optional. Create superuser with python manage.py superuser

5. Optional. Create user with python manage.py user

6. Both have the following optional arguments -email admin@ethodoxy.net -password dwarfstar

7. Create a PostgreSQL database name ethodoxy-api.

8. Set up the following environment variables

    DEBUG
    DJANGO_SETTINGS_MODULE=ethodoxy-api.settings.dev
    SECRET_KEY
    EMAIL_HOST_PASSWORD
    EMAIL_PORT
    ALLOWED_HOSTS=localhost
    DATABASE_URL
    DB_PASSWORD
   

9. Set up Douay-Rheims bible database by running the following commands in order

    python manage.py create_version -name -location
    python manage.py create_ot
    python manage.py create_nt
    python manage.py create_chapters
    python manage.py create_verses
    python manage.py create_commentary # challoner commentary
   

Contributing

I haven't figured it out yet. Feel free to message me at orjichidi95@gmail.com

Querying

1. How to query verses