summaryrefslogtreecommitdiffstats
path: root/python_client/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-01-09 11:29:42 -0800
committerBryan Newbold <bnewbold@robocracy.org>2019-01-09 11:29:50 -0800
commitc5035bafd3c1700621d0aee12a2aa5b2fcc145c3 (patch)
tree33bba8259ee0b37360f22ce8b6aa218180f646e1 /python_client/README.md
parent6571c1d98aa1e13f28e1d2557408a369d4e3220f (diff)
downloadfatcat-c5035bafd3c1700621d0aee12a2aa5b2fcc145c3.tar.gz
fatcat-c5035bafd3c1700621d0aee12a2aa5b2fcc145c3.zip
continue breaking out python client
Diffstat (limited to 'python_client/README.md')
-rw-r--r--python_client/README.md208
1 files changed, 208 insertions, 0 deletions
diff --git a/python_client/README.md b/python_client/README.md
new file mode 100644
index 00000000..8704641e
--- /dev/null
+++ b/python_client/README.md
@@ -0,0 +1,208 @@
+# fatcat-client
+A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata
+
+This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 0.1.0
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on Github, you can install directly from Github
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import fatcat_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import fatcat_client
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+from __future__ import print_function
+import time
+import fatcat_client
+from fatcat_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: Bearer
+fatcat_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# fatcat_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
+# create an instance of the API class
+api_instance = fatcat_client.DefaultApi()
+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**](docs/DefaultApi.md#accept_editgroup) | **POST** /editgroup/{editgroup_id}/accept |
+*DefaultApi* | [**auth_check**](docs/DefaultApi.md#auth_check) | **GET** /auth/check |
+*DefaultApi* | [**auth_oidc**](docs/DefaultApi.md#auth_oidc) | **POST** /auth/oidc |
+*DefaultApi* | [**create_container**](docs/DefaultApi.md#create_container) | **POST** /container |
+*DefaultApi* | [**create_container_batch**](docs/DefaultApi.md#create_container_batch) | **POST** /container/batch |
+*DefaultApi* | [**create_creator**](docs/DefaultApi.md#create_creator) | **POST** /creator |
+*DefaultApi* | [**create_creator_batch**](docs/DefaultApi.md#create_creator_batch) | **POST** /creator/batch |
+*DefaultApi* | [**create_editgroup**](docs/DefaultApi.md#create_editgroup) | **POST** /editgroup |
+*DefaultApi* | [**create_file**](docs/DefaultApi.md#create_file) | **POST** /file |
+*DefaultApi* | [**create_file_batch**](docs/DefaultApi.md#create_file_batch) | **POST** /file/batch |
+*DefaultApi* | [**create_fileset**](docs/DefaultApi.md#create_fileset) | **POST** /fileset |
+*DefaultApi* | [**create_fileset_batch**](docs/DefaultApi.md#create_fileset_batch) | **POST** /fileset/batch |
+*DefaultApi* | [**create_release**](docs/DefaultApi.md#create_release) | **POST** /release |
+*DefaultApi* | [**create_release_batch**](docs/DefaultApi.md#create_release_batch) | **POST** /release/batch |
+*DefaultApi* | [**create_webcapture**](docs/DefaultApi.md#create_webcapture) | **POST** /webcapture |
+*DefaultApi* | [**create_webcapture_batch**](docs/DefaultApi.md#create_webcapture_batch) | **POST** /webcapture/batch |
+*DefaultApi* | [**create_work**](docs/DefaultApi.md#create_work) | **POST** /work |
+*DefaultApi* | [**create_work_batch**](docs/DefaultApi.md#create_work_batch) | **POST** /work/batch |
+*DefaultApi* | [**delete_container**](docs/DefaultApi.md#delete_container) | **DELETE** /container/{ident} |
+*DefaultApi* | [**delete_container_edit**](docs/DefaultApi.md#delete_container_edit) | **DELETE** /container/edit/{edit_id} |
+*DefaultApi* | [**delete_creator**](docs/DefaultApi.md#delete_creator) | **DELETE** /creator/{ident} |
+*DefaultApi* | [**delete_creator_edit**](docs/DefaultApi.md#delete_creator_edit) | **DELETE** /creator/edit/{edit_id} |
+*DefaultApi* | [**delete_file**](docs/DefaultApi.md#delete_file) | **DELETE** /file/{ident} |
+*DefaultApi* | [**delete_file_edit**](docs/DefaultApi.md#delete_file_edit) | **DELETE** /file/edit/{edit_id} |
+*DefaultApi* | [**delete_fileset**](docs/DefaultApi.md#delete_fileset) | **DELETE** /fileset/{ident} |
+*DefaultApi* | [**delete_fileset_edit**](docs/DefaultApi.md#delete_fileset_edit) | **DELETE** /fileset/edit/{edit_id} |
+*DefaultApi* | [**delete_release**](docs/DefaultApi.md#delete_release) | **DELETE** /release/{ident} |
+*DefaultApi* | [**delete_release_edit**](docs/DefaultApi.md#delete_release_edit) | **DELETE** /release/edit/{edit_id} |
+*DefaultApi* | [**delete_webcapture**](docs/DefaultApi.md#delete_webcapture) | **DELETE** /webcapture/{ident} |
+*DefaultApi* | [**delete_webcapture_edit**](docs/DefaultApi.md#delete_webcapture_edit) | **DELETE** /webcapture/edit/{edit_id} |
+*DefaultApi* | [**delete_work**](docs/DefaultApi.md#delete_work) | **DELETE** /work/{ident} |
+*DefaultApi* | [**delete_work_edit**](docs/DefaultApi.md#delete_work_edit) | **DELETE** /work/edit/{edit_id} |
+*DefaultApi* | [**get_changelog**](docs/DefaultApi.md#get_changelog) | **GET** /changelog |
+*DefaultApi* | [**get_changelog_entry**](docs/DefaultApi.md#get_changelog_entry) | **GET** /changelog/{index} |
+*DefaultApi* | [**get_container**](docs/DefaultApi.md#get_container) | **GET** /container/{ident} |
+*DefaultApi* | [**get_container_edit**](docs/DefaultApi.md#get_container_edit) | **GET** /container/edit/{edit_id} |
+*DefaultApi* | [**get_container_history**](docs/DefaultApi.md#get_container_history) | **GET** /container/{ident}/history |
+*DefaultApi* | [**get_container_redirects**](docs/DefaultApi.md#get_container_redirects) | **GET** /container/{ident}/redirects |
+*DefaultApi* | [**get_container_revision**](docs/DefaultApi.md#get_container_revision) | **GET** /container/rev/{rev_id} |
+*DefaultApi* | [**get_creator**](docs/DefaultApi.md#get_creator) | **GET** /creator/{ident} |
+*DefaultApi* | [**get_creator_edit**](docs/DefaultApi.md#get_creator_edit) | **GET** /creator/edit/{edit_id} |
+*DefaultApi* | [**get_creator_history**](docs/DefaultApi.md#get_creator_history) | **GET** /creator/{ident}/history |
+*DefaultApi* | [**get_creator_redirects**](docs/DefaultApi.md#get_creator_redirects) | **GET** /creator/{ident}/redirects |
+*DefaultApi* | [**get_creator_releases**](docs/DefaultApi.md#get_creator_releases) | **GET** /creator/{ident}/releases |
+*DefaultApi* | [**get_creator_revision**](docs/DefaultApi.md#get_creator_revision) | **GET** /creator/rev/{rev_id} |
+*DefaultApi* | [**get_editgroup**](docs/DefaultApi.md#get_editgroup) | **GET** /editgroup/{editgroup_id} |
+*DefaultApi* | [**get_editor**](docs/DefaultApi.md#get_editor) | **GET** /editor/{editor_id} |
+*DefaultApi* | [**get_editor_changelog**](docs/DefaultApi.md#get_editor_changelog) | **GET** /editor/{editor_id}/changelog |
+*DefaultApi* | [**get_file**](docs/DefaultApi.md#get_file) | **GET** /file/{ident} |
+*DefaultApi* | [**get_file_edit**](docs/DefaultApi.md#get_file_edit) | **GET** /file/edit/{edit_id} |
+*DefaultApi* | [**get_file_history**](docs/DefaultApi.md#get_file_history) | **GET** /file/{ident}/history |
+*DefaultApi* | [**get_file_redirects**](docs/DefaultApi.md#get_file_redirects) | **GET** /file/{ident}/redirects |
+*DefaultApi* | [**get_file_revision**](docs/DefaultApi.md#get_file_revision) | **GET** /file/rev/{rev_id} |
+*DefaultApi* | [**get_fileset**](docs/DefaultApi.md#get_fileset) | **GET** /fileset/{ident} |
+*DefaultApi* | [**get_fileset_edit**](docs/DefaultApi.md#get_fileset_edit) | **GET** /fileset/edit/{edit_id} |
+*DefaultApi* | [**get_fileset_history**](docs/DefaultApi.md#get_fileset_history) | **GET** /fileset/{ident}/history |
+*DefaultApi* | [**get_fileset_redirects**](docs/DefaultApi.md#get_fileset_redirects) | **GET** /fileset/{ident}/redirects |
+*DefaultApi* | [**get_fileset_revision**](docs/DefaultApi.md#get_fileset_revision) | **GET** /fileset/rev/{rev_id} |
+*DefaultApi* | [**get_release**](docs/DefaultApi.md#get_release) | **GET** /release/{ident} |
+*DefaultApi* | [**get_release_edit**](docs/DefaultApi.md#get_release_edit) | **GET** /release/edit/{edit_id} |
+*DefaultApi* | [**get_release_files**](docs/DefaultApi.md#get_release_files) | **GET** /release/{ident}/files |
+*DefaultApi* | [**get_release_filesets**](docs/DefaultApi.md#get_release_filesets) | **GET** /release/{ident}/filesets |
+*DefaultApi* | [**get_release_history**](docs/DefaultApi.md#get_release_history) | **GET** /release/{ident}/history |
+*DefaultApi* | [**get_release_redirects**](docs/DefaultApi.md#get_release_redirects) | **GET** /release/{ident}/redirects |
+*DefaultApi* | [**get_release_revision**](docs/DefaultApi.md#get_release_revision) | **GET** /release/rev/{rev_id} |
+*DefaultApi* | [**get_release_webcaptures**](docs/DefaultApi.md#get_release_webcaptures) | **GET** /release/{ident}/webcaptures |
+*DefaultApi* | [**get_webcapture**](docs/DefaultApi.md#get_webcapture) | **GET** /webcapture/{ident} |
+*DefaultApi* | [**get_webcapture_edit**](docs/DefaultApi.md#get_webcapture_edit) | **GET** /webcapture/edit/{edit_id} |
+*DefaultApi* | [**get_webcapture_history**](docs/DefaultApi.md#get_webcapture_history) | **GET** /webcapture/{ident}/history |
+*DefaultApi* | [**get_webcapture_redirects**](docs/DefaultApi.md#get_webcapture_redirects) | **GET** /webcapture/{ident}/redirects |
+*DefaultApi* | [**get_webcapture_revision**](docs/DefaultApi.md#get_webcapture_revision) | **GET** /webcapture/rev/{rev_id} |
+*DefaultApi* | [**get_work**](docs/DefaultApi.md#get_work) | **GET** /work/{ident} |
+*DefaultApi* | [**get_work_edit**](docs/DefaultApi.md#get_work_edit) | **GET** /work/edit/{edit_id} |
+*DefaultApi* | [**get_work_history**](docs/DefaultApi.md#get_work_history) | **GET** /work/{ident}/history |
+*DefaultApi* | [**get_work_redirects**](docs/DefaultApi.md#get_work_redirects) | **GET** /work/{ident}/redirects |
+*DefaultApi* | [**get_work_releases**](docs/DefaultApi.md#get_work_releases) | **GET** /work/{ident}/releases |
+*DefaultApi* | [**get_work_revision**](docs/DefaultApi.md#get_work_revision) | **GET** /work/rev/{rev_id} |
+*DefaultApi* | [**lookup_container**](docs/DefaultApi.md#lookup_container) | **GET** /container/lookup |
+*DefaultApi* | [**lookup_creator**](docs/DefaultApi.md#lookup_creator) | **GET** /creator/lookup |
+*DefaultApi* | [**lookup_file**](docs/DefaultApi.md#lookup_file) | **GET** /file/lookup |
+*DefaultApi* | [**lookup_release**](docs/DefaultApi.md#lookup_release) | **GET** /release/lookup |
+*DefaultApi* | [**update_container**](docs/DefaultApi.md#update_container) | **PUT** /container/{ident} |
+*DefaultApi* | [**update_creator**](docs/DefaultApi.md#update_creator) | **PUT** /creator/{ident} |
+*DefaultApi* | [**update_editor**](docs/DefaultApi.md#update_editor) | **PUT** /editor/{editor_id} |
+*DefaultApi* | [**update_file**](docs/DefaultApi.md#update_file) | **PUT** /file/{ident} |
+*DefaultApi* | [**update_fileset**](docs/DefaultApi.md#update_fileset) | **PUT** /fileset/{ident} |
+*DefaultApi* | [**update_release**](docs/DefaultApi.md#update_release) | **PUT** /release/{ident} |
+*DefaultApi* | [**update_webcapture**](docs/DefaultApi.md#update_webcapture) | **PUT** /webcapture/{ident} |
+*DefaultApi* | [**update_work**](docs/DefaultApi.md#update_work) | **PUT** /work/{ident} |
+
+
+## Documentation For Models
+
+ - [AuthOidc](docs/AuthOidc.md)
+ - [AuthOidcResult](docs/AuthOidcResult.md)
+ - [ChangelogEntry](docs/ChangelogEntry.md)
+ - [ContainerEntity](docs/ContainerEntity.md)
+ - [CreatorEntity](docs/CreatorEntity.md)
+ - [Editgroup](docs/Editgroup.md)
+ - [EditgroupEdits](docs/EditgroupEdits.md)
+ - [Editor](docs/Editor.md)
+ - [EntityEdit](docs/EntityEdit.md)
+ - [EntityHistoryEntry](docs/EntityHistoryEntry.md)
+ - [ErrorResponse](docs/ErrorResponse.md)
+ - [FileEntity](docs/FileEntity.md)
+ - [FileEntityUrls](docs/FileEntityUrls.md)
+ - [FilesetEntity](docs/FilesetEntity.md)
+ - [FilesetEntityManifest](docs/FilesetEntityManifest.md)
+ - [ReleaseContrib](docs/ReleaseContrib.md)
+ - [ReleaseEntity](docs/ReleaseEntity.md)
+ - [ReleaseEntityAbstracts](docs/ReleaseEntityAbstracts.md)
+ - [ReleaseRef](docs/ReleaseRef.md)
+ - [Success](docs/Success.md)
+ - [WebcaptureEntity](docs/WebcaptureEntity.md)
+ - [WebcaptureEntityArchiveUrls](docs/WebcaptureEntityArchiveUrls.md)
+ - [WebcaptureEntityCdx](docs/WebcaptureEntityCdx.md)
+ - [WorkEntity](docs/WorkEntity.md)
+
+
+## Documentation For Authorization
+
+
+## Bearer
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+
+## Author
+
+
+