fatcat.wiki（一个书目数据库）的API客户端库
项目描述
fatcat-openapi-client
Fatcat是一个可扩展的、带版本的、面向API的书目实体和文件元数据目录。
此Python包由OpenAPI Generator项目自动生成
- API版本：0.5.0
- 包版本：0.5.0
- 构建包：org.openapitools.codegen.languages.PythonClientCodegen 更多信息，请访问 https://fatcat.wiki
要求。
Python 3.5+
安装 & 使用
pip安装
如果Python包托管在仓库中，您可以直接使用以下命令安装
pip install fatcat-openapi-client
(您可能需要以root权限运行pip：sudo pip install fatcat-openapi-client)
然后导入包
import fatcat_openapi_client
Setuptools
通过 Setuptools 安装。
python setup.py install --user
（或使用 sudo python setup.py install 为所有用户安装包）
然后导入包
import fatcat_openapi_client
入门指南
请按照 安装流程 进行操作，然后运行以下命令
from __future__ import print_function
import time
import fatcat_openapi_client
from fatcat_openapi_client.rest import ApiException
from pprint import pprint
configuration = fatcat_openapi_client.Configuration()
# Configure API key authorization: Bearer
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# Defining host is optional and default to https://api.fatcat.wiki/v0
configuration.host = "https://api.fatcat.wiki/v0"
# Create an instance of the API class
api_instance = fatcat_openapi_client.DefaultApi(fatcat_openapi_client.ApiClient(configuration))
editgroup_id = 'editgroup_id_example' # str | base32-encoded unique identifier
try:
api_response = api_instance.accept_editgroup(editgroup_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->accept_editgroup: %s\n" % e)
API端点文档
所有URI都是相对于 https://api.fatcat.wiki/v0
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| DefaultApi | accept_editgroup | POST /editgroup/{editgroup_id}/accept | |
| DefaultApi | auth_check | GET /auth/check | |
| DefaultApi | auth_oidc | POST /auth/oidc | |
| DefaultApi | create_auth_token | POST /auth/token/{editor_id} | |
| DefaultApi | create_container | POST /editgroup/{editgroup_id}/container | |
| DefaultApi | create_container_auto_batch | POST /editgroup/auto/container/batch | |
| DefaultApi | create_creator | POST /editgroup/{editgroup_id}/creator | |
| DefaultApi | create_creator_auto_batch | POST /editgroup/auto/creator/batch | |
| DefaultApi | create_editgroup | POST /editgroup | |
| DefaultApi | create_editgroup_annotation | POST /editgroup/{editgroup_id}/annotation | |
| DefaultApi | create_file | POST /editgroup/{editgroup_id}/file | |
| DefaultApi | create_file_auto_batch | POST /editgroup/auto/file/batch | |
| DefaultApi | create_fileset | POST /editgroup/{editgroup_id}/fileset | |
| DefaultApi | create_fileset_auto_batch | POST /editgroup/auto/fileset/batch | |
| DefaultApi | create_release | POST /editgroup/{editgroup_id}/release | |
| DefaultApi | create_release_auto_batch | POST /editgroup/auto/release/batch | |
| DefaultApi | create_webcapture | POST /editgroup/{editgroup_id}/webcapture | |
| DefaultApi | create_webcapture_auto_batch | POST /editgroup/auto/webcapture/batch | |
| DefaultApi | create_work | POST /editgroup/{editgroup_id}/work | |
| DefaultApi | create_work_auto_batch | POST /editgroup/auto/work/batch | |
| DefaultApi | delete_container | DELETE /editgroup/{editgroup_id}/container/{ident} | |
| DefaultApi | delete_container_edit | DELETE /editgroup/{editgroup_id}/container/edit/{edit_id} | |
| DefaultApi | delete_creator | DELETE /editgroup/{editgroup_id}/creator/{ident} | |
| DefaultApi | delete_creator_edit | DELETE /editgroup/{editgroup_id}/creator/edit/{edit_id} | |
| DefaultApi | delete_file | DELETE /editgroup/{editgroup_id}/file/{ident} | |
| DefaultApi | delete_file_edit | DELETE /editgroup/{editgroup_id}/file/edit/{edit_id} | |
| DefaultApi | delete_fileset | DELETE /editgroup/{editgroup_id}/fileset/{ident} | |
| DefaultApi | delete_fileset_edit | DELETE /editgroup/{editgroup_id}/fileset/edit/{edit_id} | |
| DefaultApi | delete_release | DELETE /editgroup/{editgroup_id}/release/{ident} | |
| DefaultApi | delete_release_edit | DELETE /editgroup/{editgroup_id}/release/edit/{edit_id} | |
| DefaultApi | delete_webcapture | DELETE /editgroup/{editgroup_id}/webcapture/{ident} | |
| DefaultApi | delete_webcapture_edit | DELETE /editgroup/{editgroup_id}/webcapture/edit/{edit_id} | |
| DefaultApi | delete_work | DELETE /editgroup/{editgroup_id}/work/{ident} | |
| DefaultApi | delete_work_edit | DELETE /editgroup/{editgroup_id}/work/edit/{edit_id} | |
| DefaultApi | get_changelog | GET /changelog | |
| DefaultApi | get_changelog_entry | GET /changelog/{index} | |
| DefaultApi | get_container | GET /container/{ident} | |
| DefaultApi | get_container_edit | GET /container/edit/{edit_id} | |
| DefaultApi | get_container_history | GET /container/{ident}/history | |
| DefaultApi | get_container_redirects | GET /container/{ident}/redirects | |
| DefaultApi | get_container_revision | GET /container/rev/{rev_id} | |
| DefaultApi | get_creator | GET /creator/{ident} | |
| DefaultApi | get_creator_edit | GET /creator/edit/{edit_id} | |
| DefaultApi | get_creator_history | GET /creator/{ident}/history | |
| DefaultApi | get_creator_redirects | GET /creator/{ident}/redirects | |
| DefaultApi | get_creator_releases | GET /creator/{ident}/releases | |
| DefaultApi | get_creator_revision | GET /creator/rev/{rev_id} | |
| DefaultApi | get_editgroup | GET /editgroup/{editgroup_id} | |
| DefaultApi | get_editgroup_annotations | GET /editgroup/{editgroup_id}/annotations | |
| DefaultApi | get_editgroups_reviewable | GET /editgroup/reviewable | |
| DefaultApi | get_editor | GET /editor/{editor_id} | |
| DefaultApi | get_editor_annotations | GET /editor/{editor_id}/annotations | |
| DefaultApi | get_editor_editgroups | GET /editor/{editor_id}/editgroups | |
| DefaultApi | get_file | GET /file/{ident} | |
| DefaultApi | get_file_edit | GET /file/edit/{edit_id} | |
| DefaultApi | get_file_history | GET /file/{ident}/history | |
| DefaultApi | get_file_redirects | GET /file/{ident}/redirects | |
| DefaultApi | get_file_revision | GET /file/rev/{rev_id} | |
| DefaultApi | 获取文件集 | GET /fileset/{ident} | |
| DefaultApi | 获取文件集编辑 | GET /fileset/edit/{edit_id} | |
| DefaultApi | 获取文件集历史 | GET /fileset/{ident}/history | |
| DefaultApi | 获取文件集重定向 | GET /fileset/{ident}/redirects | |
| DefaultApi | 获取文件集修订版 | GET /fileset/rev/{rev_id} | |
| DefaultApi | 获取发布版 | GET /release/{ident} | |
| DefaultApi | 获取发布版编辑 | GET /release/edit/{edit_id} | |
| DefaultApi | 获取发布版文件 | GET /release/{ident}/files | |
| DefaultApi | 获取发布版文件集 | GET /release/{ident}/filesets | |
| DefaultApi | 获取发布版历史 | GET /release/{ident}/history | |
| DefaultApi | 获取发布版重定向 | GET /release/{ident}/redirects | |
| DefaultApi | 获取发布版修订版 | GET /release/rev/{rev_id} | |
| DefaultApi | 获取发布版网页快照 | GET /release/{ident}/webcaptures | |
| DefaultApi | 获取网页快照 | GET /webcapture/{ident} | |
| DefaultApi | 获取网页快照编辑 | GET /webcapture/edit/{edit_id} | |
| DefaultApi | 获取网页快照历史 | GET /webcapture/{ident}/history | |
| DefaultApi | 获取网页快照重定向 | GET /webcapture/{ident}/redirects | |
| DefaultApi | 获取网页快照修订版 | GET /webcapture/rev/{rev_id} | |
| DefaultApi | 获取作品 | GET /work/{ident} | |
| DefaultApi | 获取作品编辑 | GET /work/edit/{edit_id} | |
| DefaultApi | 获取作品历史 | GET /work/{ident}/history | |
| DefaultApi | 获取作品重定向 | GET /work/{ident}/redirects | |
| DefaultApi | 获取作品发布版 | GET /work/{ident}/releases | |
| DefaultApi | 获取作品修订版 | GET /work/rev/{rev_id} | |
| DefaultApi | 查找容器 | GET /container/lookup | |
| DefaultApi | 查找创建者 | GET /creator/lookup | |
| DefaultApi | 查找编辑者 | GET /editor/lookup | |
| DefaultApi | 查找文件 | GET /file/lookup | |
| DefaultApi | 查找发布版 | GET /release/lookup | |
| DefaultApi | 更新容器 | PUT /editgroup/{editgroup_id}/container/{ident} | |
| DefaultApi | 更新创建者 | PUT /editgroup/{editgroup_id}/creator/{ident} | |
| DefaultApi | 更新编辑组 | PUT /editgroup/{editgroup_id} | |
| DefaultApi | 更新编辑者 | PUT /editor/{editor_id} | |
| DefaultApi | 更新文件 | PUT /editgroup/{editgroup_id}/file/{ident} | |
| DefaultApi | 更新文件集 | PUT /editgroup/{editgroup_id}/fileset/{ident} | |
| DefaultApi | 更新发布版 | PUT /editgroup/{editgroup_id}/release/{ident} | |
| DefaultApi | 更新网页快照 | PUT /editgroup/{editgroup_id}/webcapture/{ident} | |
| DefaultApi | 更新作品 | PUT /editgroup/{editgroup_id}/work/{ident} |
模型文档
- AuthOidc
- AuthOidcResult
- AuthTokenResult
- ChangelogEntry
- ContainerAutoBatch
- ContainerEntity
- CreatorAutoBatch
- CreatorEntity
- Editgroup
- EditgroupAnnotation
- EditgroupEdits
- Editor
- EntityEdit
- EntityHistoryEntry
- ErrorResponse
- FileAutoBatch
- FileEntity
- FileUrl
- FilesetAutoBatch
- FilesetEntity
- FilesetFile
- FilesetUrl
- ReleaseAbstract
- ReleaseAutoBatch
- ReleaseContrib
- ReleaseEntity
- ReleaseExtIds
- ReleaseRef
- Success
- WebcaptureAutoBatch
- WebcaptureCdxLine
- WebcaptureEntity
- WebcaptureUrl
- WorkAutoBatch
- WorkEntity
授权文档
Bearer
- 类型: API密钥
- API密钥参数名: Authorization
- 位置: HTTP头
作者
Bryan Newbold bnewbold@archive.org
下载文件
下载适用于您平台的应用程序。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
fatcat_openapi_client-0.5.0.tar.gz (68.7 kB 查看哈希值)
构建分发
关闭
哈希值 for fatcat_openapi_client-0.5.0-py2.py3-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 7d3e8fc1ef2b34dccf580be0233900f8c6c88cd74089b8f5c3fa72946a9484dd |
|
| MD5 | aa5aab4843258372aa39692b8bca9367 |
|
| BLAKE2b-256 | 700b71c9e1ee7698a00cb396183c162526a803cc595004cecb65158cb6c9399a |