bhagavad-gita-api

v2.0.2

Bhagavad Gita API allows any developer to use content from Bhagavad Gita in their applications. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

PyPI

GitHub

Package Health Score

51 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Popularity

Limited

GitHub Stars: 183
Forks: 35
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package bhagavad-gita-api, we found that it has been starred 183 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jul 24, 2021
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like bhagavad-gita-api is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 7
Open PR: 11
Last Release: 3 years ago
Last Commit: 1 year ago

Further analysis of the maintenance status of bhagavad-gita-api based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for bhagavad-gita-api is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the bhagavad-gita-api repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like bhagavad-gita-api is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8,<4.0

Age: 3 years
Latest Release: 3 years ago
Dependencies: 13 Direct
Versions: 3
Maintainers: 0
Wheels: OS Independent

Readme

Bhagavad Gita API

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

GitHub issues PyPI - Python Version

Usage

The Bhagavad Gita API allows any developer to use content from Gita in their apps. This API is built with FastAPI which is based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema.

Documentation for this API is availaible in two interactive formats:

If you are interested in using this API for your application, please register an account at RapidAPI where you'll get both the credentials as well as sample code in your language of choice. The API is 100% FREE to use.

Projects

Here is a list of interesting projects using this API.

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

The official API is free to use for all. But If you wish you can self host anywhere you want.

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

Using pipx > Note If you dont have pipx, just pip install pipx
```
pipx run bhagavad-gita-api
```

Or using docker

docker run -it -p 8081:8081 --env-file=.env bhagavadgita/bhagavad-gita-api

Now open http://localhost:8081/docs to see docs. To stop the server press Ctrl + C on your keyboard.

By default an in-memory SQLite database is used. But you configure to use any SQL database of your choice. The official version uses PostgreSQL.

Looking to deploy on a cloud platform ? We have detailed docs to deploy to the following platforms:

Configuration

Here is the list of supported environment variables.

Name	Description	Default
`TESTER_API_KEY`	The API key for testing.	`None`
`SQLALCHEMY_DATABASE_URI`	The DSN for your database connection.	`sqlite://` (in memory SQLite db)

If you want to configure your deployment even more, then please take a look at module config.py.

To set the environment variables, you may simply use a .env file where you specify the values in the format of KEY=VALUE.

Development

Feel free to use the issue tracker for bugs and feature requests.

Looking to contribute code ? PRs are most welcome! To get started with developing this API, please read the contributing guide.

Community

Join the Discord chat server and hang out with others in the community.

You can also use GitHub Discussions to ask questions or tell us about projects you have built using this API.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Anubhav Gupta}
💻

_{Sanuj Sood}
💻

_{Aahnik Daw}
💻

_{Akshat Joshi}
💻

_{Amritpal Singh}
💻

_{Niku Singh}
💻

_{sreevardhanreddi}
💻 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!

bhagavad-gita-api dependencies

fastapi graphene graphene-elastic graphene-sqlalchemy graphene-sqlalchemy-filter gunicorn psycopg2-pgevents python-dotenv pytz rich sqlalchemy typer uvicorn

FAQs

What is bhagavad-gita-api?

Bhagavad Gita API allows any developer to use content from Bhagavad Gita in their applications. Visit Snyk Advisor to see a full health score report for bhagavad-gita-api, including popularity, security, maintenance & community analysis.

Is bhagavad-gita-api popular?

The python package bhagavad-gita-api receives a total of 55 weekly downloads. As such, bhagavad-gita-api popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is bhagavad-gita-api well maintained?

We found indications that bhagavad-gita-api is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is bhagavad-gita-api safe to use?

The python package bhagavad-gita-api was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 December-2024, at 02:47 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Bhagavad Gita API

Usage

Projects

Self Hosting

Configuration

Development

Community

Contributors ✨

bhagavad-gita-api dependencies

FAQs

What is bhagavad-gita-api?

Is bhagavad-gita-api popular?

Is bhagavad-gita-api well maintained?

Is bhagavad-gita-api safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues