fatcat-openapi-client
Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 0.5.0
- Package version: 0.5.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://fatcat.wiki
Requirements.
Python 3.5+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install fatcat-openapi-client
(you may need to run pip with root permission: sudo pip install fatcat-openapi-client)
Then import the package:
import fatcat_openapi_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import fatcat_openapi_client
Getting Started
Please follow the installation procedure and then run the following:
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)
Documentation for API Endpoints
All URIs are relative to https://api.fatcat.wiki/v0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| 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 | GET /fileset/{ident} | |
| DefaultApi | get_fileset_edit | GET /fileset/edit/{edit_id} | |
| DefaultApi | get_fileset_history | GET /fileset/{ident}/history | |
| DefaultApi | get_fileset_redirects | GET /fileset/{ident}/redirects | |
| DefaultApi | get_fileset_revision | GET /fileset/rev/{rev_id} | |
| DefaultApi | get_release | GET /release/{ident} | |
| DefaultApi | get_release_edit | GET /release/edit/{edit_id} | |
| DefaultApi | get_release_files | GET /release/{ident}/files | |
| DefaultApi | get_release_filesets | GET /release/{ident}/filesets | |
| DefaultApi | get_release_history | GET /release/{ident}/history | |
| DefaultApi | get_release_redirects | GET /release/{ident}/redirects | |
| DefaultApi | get_release_revision | GET /release/rev/{rev_id} | |
| DefaultApi | get_release_webcaptures | GET /release/{ident}/webcaptures | |
| DefaultApi | get_webcapture | GET /webcapture/{ident} | |
| DefaultApi | get_webcapture_edit | GET /webcapture/edit/{edit_id} | |
| DefaultApi | get_webcapture_history | GET /webcapture/{ident}/history | |
| DefaultApi | get_webcapture_redirects | GET /webcapture/{ident}/redirects | |
| DefaultApi | get_webcapture_revision | GET /webcapture/rev/{rev_id} | |
| DefaultApi | get_work | GET /work/{ident} | |
| DefaultApi | get_work_edit | GET /work/edit/{edit_id} | |
| DefaultApi | get_work_history | GET /work/{ident}/history | |
| DefaultApi | get_work_redirects | GET /work/{ident}/redirects | |
| DefaultApi | get_work_releases | GET /work/{ident}/releases | |
| DefaultApi | get_work_revision | GET /work/rev/{rev_id} | |
| DefaultApi | lookup_container | GET /container/lookup | |
| DefaultApi | lookup_creator | GET /creator/lookup | |
| DefaultApi | lookup_editor | GET /editor/lookup | |
| DefaultApi | lookup_file | GET /file/lookup | |
| DefaultApi | lookup_release | GET /release/lookup | |
| DefaultApi | update_container | PUT /editgroup/{editgroup_id}/container/{ident} | |
| DefaultApi | update_creator | PUT /editgroup/{editgroup_id}/creator/{ident} | |
| DefaultApi | update_editgroup | PUT /editgroup/{editgroup_id} | |
| DefaultApi | update_editor | PUT /editor/{editor_id} | |
| DefaultApi | update_file | PUT /editgroup/{editgroup_id}/file/{ident} | |
| DefaultApi | update_fileset | PUT /editgroup/{editgroup_id}/fileset/{ident} | |
| DefaultApi | update_release | PUT /editgroup/{editgroup_id}/release/{ident} | |
| DefaultApi | update_webcapture | PUT /editgroup/{editgroup_id}/webcapture/{ident} | |
| DefaultApi | update_work | PUT /editgroup/{editgroup_id}/work/{ident} |
Documentation For Models
- 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
Documentation For Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Bryan Newbold bnewbold@archive.org
Metadata
Release files for fatcat-openapi-client 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fatcat_openapi_client-0.5.0.tar.gz | 68.7 kB | Without provenance | Details for fatcat_openapi_client-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fatcat_openapi_client-0.5.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for fatcat_openapi_client-0.5.0-py2.py3-none-any.whl |
Total release size: 179.9 kB
Release files / fatcat_openapi_client-0.5.0.tar.gz
| Download URL | fatcat_openapi_client-0.5.0.tar.gz |
|---|---|
| Size | 68.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a40019def2245c6cdfad0e44c90c4a9e0f611d2ca643cf63948ab65395891497
|
|
BLAKE2b-256 checksum How to use checksums |
7800f27beeaaca1ec32391954d88a60a0b426d3b2d8875050604ff66343ee763
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3
|
Release files / fatcat_openapi_client-0.5.0-py2.py3-none-any.whl
| Download URL | fatcat_openapi_client-0.5.0-py2.py3-none-any.whl |
|---|---|
| Size | 111.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
7d3e8fc1ef2b34dccf580be0233900f8c6c88cd74089b8f5c3fa72946a9484dd
|
|
BLAKE2b-256 checksum How to use checksums |
700b71c9e1ee7698a00cb396183c162526a803cc595004cecb65158cb6c9399a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3
|
Security for fatcat-openapi-client 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.