访问古兰经和圣训数据的桌面api
ic-desktop-api的Python项目详细描述
简介
"Islam Companion Desktop API"项目是一个用python语言编写的API(应用程序编程接口),它允许用户将神圣的古兰经和圣训数据添加到他们的应用程序中。目前它提供乌尔都语的古兰经和圣训翻译。计划支持其他语言。
使用Islam Companion Desktop API的应用程序的一个例子是Islam Companion Desktop应用程序。
Islam Companion Desktop API的目标是帮助用户开发提供有关Islam知识的桌面应用程序。
功能
Islam Companion桌面API具有以下功能:
- 它提供乌尔都语的古兰经和圣训翻译。计划支持更多语言
- 它提供有关《古兰经》和《圣训》数据的元数据
- 源代码可在gpl许可证下找到。
- 源代码注释良好,易于更新
- 数据存储在sqlite3数据库中,可以使用sqlite3 python包轻松访问
要求
Islam Companion Desktop API需要OS和SQLite3 Python包。这些包是标准python发行版的一部分
安装
以下步骤可用于安装"Islam Companion Desktop API":
- 使用以下命令创建python虚拟环境:virtualenv-p python3.7 islam companion
- 使用以下命令激活虚拟环境:source bin/activate
- 使用以下命令从python包索引(ppi)安装:pip install ic desktop api
- 创建一个名为source的文件夹
- 从github上的源代码中下载文件夹中的测试和数据。将文件夹复制到源文件夹
- 下载古兰经sqlite数据库。将下载的文件解压缩到source/data/holy quran.db
- 下载http://islamcompanion.pakjiddat.pk/islamcompanion/data/hadith.db.tar.bz2" rel="nofollow">hadithsqlite数据库。将下载的文件解压缩到source/data/hadith.db
- 使用以下命令安装unittest2python包:pip install unittest2。它将用于对api进行单元测试
- 使用以下命令测试Quran API:python-m unittest/qran.py
- 使用以下命令测试hadith api:python-m unittest/hadith.py
用法
Islam Companion Desktop API支持以下功能:
API调用获取神圣古兰经数据
姓名:获取姓名
描述:从数据库中获取所有sura名称的列表
响应:包含sura名称列表的数字索引数组
参数:无名称:获取ruku计数
描述:获取给定sura中rukus的数量 响应:整数co获取给定sura中rukus的数量 参数:- 苏拉。苏拉号码。它应该是1到114之间的数字
名称:获取Ayat范围
说明:返回给定sura和ruku的开始和结束ayat数 响应:包含两个元素的关联数组。开始(开始Ayat编号)和结束(结束Ayat编号)
参数:- 苏拉。苏拉号码。它应该是1到114之间的数字
- 鲁库。鲁库号码。应该是1到40之间的数字
姓名:获取Ayat文本
描述:获取给定sura和ruku的ayat文本
响应:包含ayas列表的数字索引数组
参数:- 苏拉。苏拉号码。它应该是1到114之间的数字
- 鲁库。鲁库号码。应该是1到40之间的数字
< > >名称:获取源代码列表
描述:从数据库中获取所有hadith源的列表
响应:一个数字索引数组,包含一个哈德斯源列表
参数:无姓名:获取图书列表
描述:从数据库中获取给定源的所有冥书列表
响应:一个数字索引数组,包含冥王书的列表。每个索引都包含一个数字索引数组和两个元素。书号和书名 参数:- 来源。冥王之源
姓名:获取标题列表
描述:从数据库中获取给定冥书的所有冥书标题列表
响应:一个数字索引数组,包含冥王头衔列表。每个索引都包含一个数字索引数组和两个元素。标题ID和标题文本 参数:- 书本。冥王书编号
名称:获取hadith文本
描述:它获取并返回给定hadith id的hadith文本 响应:包含hadith文本的字符串 参数:- 圣训id。冥王id
< > >