パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v1.0.0

bible

1つの場所から複数の聖書APIとやり取りできるシンプルなアプリケーション

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
101
いいね数
21
Pub ポイント
130

パッケージをインストール

flutter pub add bible

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Bible パッケージは、単一のインターフェースを通じて複数の聖書APIに統合的にアクセスできるFlutter/Dartライブラリです。さまざまな聖書データソースとの統合を簡素化し、開発者が聖句の取得、テキスト検索、メタデータの取得を効率的に行えるようにします。クロスプラットフォーム対応で、Android、iOS、Web、macOS、Windows、Linuxをサポートしています。APIの違いを抽象化し、聖書コンテンツを照会するための一貫したメソッドを提供しており、信仰に基づくアプリ、学習ツール、または献身的なプラットフォームに最適です。`flutter pub add bible` による最小限のセットアップで、開発者は迅速に豊富な聖書コンテンツをアプリに組み込むことができます。

用途

  • 聖書の読み取りアプリケーション
  • 聖書の参照ツール
  • 献身と祈りのアプリ
  • 宗教教育プラットフォーム
  • クロスプラットフォーム聖書統合

主な機能

  • 統合APIインターフェース
  • 複数の聖書ソースのサポート
  • クロスプラットフォーム互換性
  • pub を通じた簡単なインストール
  • 一貫したデータ取得方法
  • 軽量で統合が簡単

適している対象

  • 宗教アプリを開発する開発者
  • 教育ソフトウェアの作成者
  • モバイルおよびウェブアプリケーションチーム
  • オープンソースプロジェクトの貢献者
  • 聖書データを必要とするアプリ

注意事項

  • 外部の聖書APIに依存しています
  • レート制限の処理が必要になる場合があります
  • データ形式の整合性は、ソースによって異なります
  • テキストベースの聖書情報の取得に限定
  • 組み込みのキャッシュメカニズムなし
  • データの取得にはインターネット接続が必要です

元の README

関連するソースリポジトリの 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 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.

カテゴリー

依存関係

依存関係一覧 2 件

  • http^0.13.3
  • reference_parser^3.0.0

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。