Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshpetit/bible
Dart Bible API package. Use multiple bible APIs from a single interface.
https://github.com/joshpetit/bible
bible christianity dart flutter
Last synced: 2 months ago
JSON representation
Dart Bible API package. Use multiple bible APIs from a single interface.
- Host: GitHub
- URL: https://github.com/joshpetit/bible
- Owner: joshpetit
- License: bsd-3-clause
- Created: 2020-11-24T19:23:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-17T01:03:56.000Z (over 3 years ago)
- Last Synced: 2024-07-30T17:33:50.545Z (6 months ago)
- Topics: bible, christianity, dart, flutter
- Language: Dart
- Homepage: https://pub.dev/packages/bible
- Size: 107 KB
- Stars: 18
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# bible
This package provides a simple interface for interacting with different bible APIs.
## Usage
This package currently only supports querying these APIs:
| Name | Requires API key| notes |
| ----- | --------- | ---- |
| [esvapi](https://api.esv.org/) | yes | |
| [getbible](https://getbible.net/api) | no |Does not support verse references that cross chapters. Genesis 2-3 ✅ Gensis 2:1 - 3:5 ❌|
| [bibleorg](https://labs.bible.org/api_web_service) | no | |
| [bibleapi](https://bible-api.com/) | no | |
Simple example:
```dart
import 'package:bible/bible.dart' as Bible;
...
var passage = await Bible.queryPassage('John 3:16'); // Will default to the GetBible API
print(passage.passage) // The text from the query
```
An example requiring an API key:
```dart
Bible.addKeys({'esvapi': 'APITOKEN'});
var passage = await Bible.queryPassage('John 3:16', providerName:'esvapi');
```
You can also pass the API key as an optional parameter:
```dart
Bible.addKeys({'esvapi': 'APITOKEN'});
var passage = await Bible.queryPassage('John 3:16', key: 'APITOKEN');
```
You can also pass query parameters through a map. See specific API documentation for those parameters.
```dart
Bible.addKeys({'esvapi': 'APITOKEN'});
var passage = await Bible.queryPassage('John 3:16', key: 'APITOKEN', parameters: {'Map': 'of params'});
```
You can specify the version or provider with optional parameters.
```dart
var passage = await Bible.queryPassage('John 3:16', providerName: 'getbible', version: 'asv');
```
**Note:**The providerName coresponds to that in the table at the beginning of this documentation.
Every time a passage is queried, the [reference_parser](https://pub.dev/packages/reference_parser) library tries to
parse the query (i.e mispelling will automatically be corrected, shortened verse forms will be allowed). To prevent
this just pass `false` to the `useParser` parameter.
```dart
var passage = await Bible.queryPassage('John 3:16', useParser: false);
```
If you import the providers library you can use can directly query every the providers or pass them
to the queryPassage function as an optional parameter
```dart
import 'package:bible/bible.dart' as Bible;
import 'package:bible/providers.dart';
//...
var prov = GetBible();
var passage = await Bible.queryPassage('John 3:16', provider: prov);
```
This is the same as using the providerName parameter but if you were to create
your own provider you could pass it to the function.
**Note**: If you create your own provider please consider contributing it back to the repository :).
## Contributing
Implementing an API isn't hard, so I'm open to having people implementing and sending pull requests
for different bible APIs. This is a great first issue and doesn't require extensive dart knowledge, just copy a provider already created and go from there!
APIs that need implementing:
| Name | Difficulty|
| ----- | --------- |
| [nltapi](https://api.nlt.to/) | easy |
| [bibliaapi](https://bibliaapi.com/docs/) | moderate |
| [scriptureapi](https://scripture.api.bible/) | hard |
For more specific information look at the [contributing guidlines](CONTRIBUTING.md).