패키지, 저장소 및 앱 카테고리 검색

GitHub 저장소joshpetit/bible

성경

다트 성경 API 패키지. 단일 인터페이스를 통해 여러 성경 API를 사용합니다.

성경 프로젝트 이미지
스타
19
포크
4
최근 푸시(UTC)
2021. 8. 17.
프로젝트 상태
활성

원본 README

아래는 영문 원문 스냅샷입니다. 최신 내용은 GitHub에서 확인하세요.

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.

Joshua Petitma GitHub avatar
GitHub 작성자

Joshua Petitma ↗

World's gladdest coder studying at Duke

DukeDurham, North Carolina공식 웹사이트 ↗
언어Dart

분류

이 저장소가 배포한 패키지

사용 중인 의존성

의존성 목록 4 개

  • http^0.13.3
  • reference_parser^3.0.0
  • pedantic개발 의존성^1.9.0
  • test개발 의존성^1.14.4

프로젝트에 맞는 저장소를 선택하려면?

사용 목적에 따라 검색하고 개발 활동을 비교한 뒤 원본 저장소에서 요구 사항을 확인하세요.

  1. 이름, 작성자 또는 설명으로 검색하고 기술 주제로 범위를 좁힙니다.
  2. 스타, 포크, 최근 푸시를 함께 비교하세요. 스타는 관심의 지표이며 품질을 보장하지 않습니다.
  3. 사용하기 전에 GitHub에서 README, 라이선스, Issues를 확인하세요.

출처 및 관리

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗