Skip to main content

Bhagavad Gita API allows any developer to use content from Bhagavad Gita in their applications.

Project description

Logo

Bhagavad Gita API v2

Code for the BhagavadGita.io v2 API, which is an app built for Gita readers by Gita readers.

View Docs · Report Bug · Request Feature

LICENSE Stars

Usage

If you are interested in using this API for your application ... read the docs.

Projects

Projects using this API.

  • bhagavatgita.io
  • Android app

Have you build something with this API ? Open a "Show and tell" discussion. The maintainers will feature your project on the README if they find it interesting.

Self Hosting

Local/Linux VPS

If you want to deploy your own instance,You can deploy the API server on your system or VPS.

  • Using pipx

    pipx run gita-api
    
  • Or using docker

    docker run -d --env-file=.env gita-org/gita-api
    

Now open http://localhost:8081/docs to see docs.

Heroku

Click here -> Configure env vars -> Deploy -> Open app

Digital Ocean

Open Dashboard -> Create -> Apps -> Docker Hub -> Repo name gita-org/gita-api -> Configure env vars

Configuration

By default SQLite database is used. But you may use any SQL database.

In your current directory, create a .env file with the following details.

For local/linux vps, you can use a .env file. For Heroku and Digital Ocean use the UI provided in their Dashboard.

Development

If you are interested in contributing to this api, see the contributing guide. PRs are most welcome!

  • Feel free to create issues for bugs and feature requests
  • If you have any questions ask in the Discusion forum

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bhagavad-gita-api-0.0.1.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

bhagavad_gita_api-0.0.1-py3-none-any.whl (13.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page