Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gita/BhagavadGita
A non-profit initiative to help spread the transcendental wisdom from the Bhagavad Gita to people around the world.
https://github.com/gita/BhagavadGita
api bhagavad-gita flask frontend krishna oauth2 open-source opensource python rest-api swagger
Last synced: about 2 months ago
JSON representation
A non-profit initiative to help spread the transcendental wisdom from the Bhagavad Gita to people around the world.
- Host: GitHub
- URL: https://github.com/gita/BhagavadGita
- Owner: gita
- License: gpl-3.0
- Created: 2018-02-07T07:01:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:26:41.000Z (about 2 years ago)
- Last Synced: 2024-04-14T06:49:28.339Z (8 months ago)
- Topics: api, bhagavad-gita, flask, frontend, krishna, oauth2, open-source, opensource, python, rest-api, swagger
- Language: Python
- Homepage: https://bhagavadgita.io
- Size: 43.5 MB
- Stars: 161
- Watchers: 10
- Forks: 23
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A not-for-profit initiative to help spread the transcendental wisdom from the Bhagavad Gita to people around the world. Built for Gita readers by Gita readers.
## ⚠️ We are in the process of redesigning the app from scratch for v2 and are actively looking for contributors who would be interested in helping out. Please join our Discord server below if you are interested.
[
](https://discord.gg/4V3VrqHyZx)
## New Repositories 👇
- **Backend**: https://github.com/gita/bhagavad-gita-api
- **Frontend**: https://github.com/gita/bhagavad-gita-frontend
---
## OLD VERSION (v1)
Frontend and REST API for BhagavadGita.io
**Backend** - Flask
**Frontend** - Material Design
**Database** - PostgreSQL, ElasticSearch
## REST API
The Bhagavad Gita Application Programming Interface (API) allows a web or mobile developer to use the Bhagavad Gita text in their web or mobile application(s). It follows some of the Best Practices for designing a REST API.
### Current version
The current version of the API is v1. We encourage you to explicitly use this version in the url.
### Schema
All API access is over HTTPS, and accessed from https://bhagavadgita.io/api/v1. All data is sent and received as JSON.
### Authentication
HTTP requests to the BHAGAVAD GITA API are protected with OAUTH2 authentication.
To be able to use the API, you need to be a registered [BhagavadGita.io](https://bhagavadgita.io) user. After signing in, you can register your applications from your Account Dashboard after which you will be issued a Client ID and Client Secret specific to an application that can be used to programatically get the access_token(valid for 300sec).
**How to get an access token?**
Make a POST request to `/auth/oauth/token` with these parameters sent in Headers -
1. Client ID - Obtained from Account Dashboard after registering an app.
2. Client Secret - Obtained from Account Dashboard after registering an app.
3. Grant Type - Use `client credentials`.
4. Scope - Use `verse` if you just want to access the verses, `chapter` if you just want to access the chapters and `verse chapter` if you want access to both.
Example -
`curl -X POST "https://bhagavadgita.io/auth/oauth/token" -H "accept: application/json" -H "content-type: application/x-www-form-urlencoded" -d "client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials&scope=verse%20chapter"`
Then, you can use the received access_token to access any of the endpoints. You can send the access_token as a header or as a query parameter.
Examples -
1. Query Parameter
`curl -X GET "https://bhagavadgita.io/v1/chapters?access_token=YOUR_ACCESS_TOKEN" -H "accept: application/json"`
2. Header
`curl -X GET \
https://bhagavadgita.io/v1/chapters \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN'`
### Documentation
We have 2 types of documenatations available for this API, both based on the Open API specification.
1. [Swagger UI](https://bhagavadgita.io/apidocs/)
2. [ReDoc](https://bhagavadgita.io/docs/)
## Developing Locally
1. Fork this repository and clone the forked repository.
2. Create and activate a Python 3 virtualenv.
3. Use `pip install -r requirements.txt` to install the requirements.
4. `python manage.py runserver` to start the server.
5. Create an environment file `config.env`. Please open an issue or email [email protected] for the credentials of the file.
6. Frontend can be accessed at `http://127.0.0.1:5000` and API docs can be accessed at `http://127.0.0.1:5000/apidocs/`.
---