Search packages, repositories and app categories

Package detailsv1.0.0

bible

A simple application to interact with multiple bible APIs from a single place

AndroidiOSWebmacOSWindowsLinux
30-day downloads
101
Likes
21
Pub points
130

Install package

flutter pub add bible

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

The Bible package is a Flutter/Dart library that provides unified access to multiple Bible APIs through a single interface. It simplifies integration with various Bible data sources, enabling developers to fetch scripture passages, search texts, and retrieve metadata efficiently. Designed for cross-platform use, it supports Android, iOS, Web, macOS, Windows, and Linux. The package abstracts API differences, offering consistent methods for querying Bible content, making it ideal for faith-based apps, study tools, or devotional platforms. With minimal setup via `flutter pub add bible`, developers can quickly incorporate rich biblical content into their applications.

Use cases

  • Bible reading applications
  • Scripture reference tools
  • Devotional and prayer apps
  • Religious education platforms
  • Cross-platform Bible integrations

Key features

  • Unified API interface
  • Support for multiple Bible sources
  • Cross-platform compatibility
  • Simple installation via pub
  • Consistent data retrieval methods
  • Lightweight and easy to integrate

Suitable for

  • Developers building religious apps
  • Educational software creators
  • Mobile and web application teams
  • Open-source project contributors
  • Apps requiring scripture data

Considerations

  • Depends on external Bible APIs
  • May require handling rate limits
  • Data format consistency varies by source
  • Limited to text-based scripture retrieval
  • No built-in caching mechanism
  • Requires internet connection for data

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

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 yes
getbible no Does not support verse references that cross chapters. Genesis 2-3 ✅ Gensis 2:1 - 3:5 ❌
bibleorg no
bibleapi no

Simple example:

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:

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:

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.

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.

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 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.

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

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 easy
bibliaapi moderate
scriptureapi hard

For more specific information look at the contributing guidlines.

Categories

Dependencies

Dependency list 2 items

  • http^0.13.3
  • reference_parser^3.0.0

Source repository

Projects using this package

No data available yet.