summaryrefslogtreecommitdiffstats
path: root/python/fatcat_client/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-11-13 12:28:20 -0800
committerBryan Newbold <bnewbold@robocracy.org>2018-11-13 12:28:20 -0800
commit2888327e9edca05d50bc6d71bf68166ee0fabcfe (patch)
tree9d7da3c09a4fa52af197fc6786e8f37659e45d90 /python/fatcat_client/README.md
parent7d17e7cac4fee2661fec6474a8aade3b38ef5448 (diff)
downloadfatcat-2888327e9edca05d50bc6d71bf68166ee0fabcfe.tar.gz
fatcat-2888327e9edca05d50bc6d71bf68166ee0fabcfe.zip
more python client library tomfoolery
Diffstat (limited to 'python/fatcat_client/README.md')
-rw-r--r--python/fatcat_client/README.md148
1 files changed, 148 insertions, 0 deletions
diff --git a/python/fatcat_client/README.md b/python/fatcat_client/README.md
new file mode 100644
index 00000000..0d072dde
--- /dev/null
+++ b/python/fatcat_client/README.md
@@ -0,0 +1,148 @@
+# 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
+# create an instance of the API class
+api_instance = fatcat_client.DefaultApi()
+id = 'id_example' # str | base32-encoded unique identifier
+
+try:
+ api_response = api_instance.accept_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 *http://localhost/v0*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DefaultApi* | [**accept_editgroup**](docs/DefaultApi.md#accept_editgroup) | **POST** /editgroup/{id}/accept |
+*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_release**](docs/DefaultApi.md#create_release) | **POST** /release |
+*DefaultApi* | [**create_release_batch**](docs/DefaultApi.md#create_release_batch) | **POST** /release/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/{id} |
+*DefaultApi* | [**delete_creator**](docs/DefaultApi.md#delete_creator) | **DELETE** /creator/{id} |
+*DefaultApi* | [**delete_file**](docs/DefaultApi.md#delete_file) | **DELETE** /file/{id} |
+*DefaultApi* | [**delete_release**](docs/DefaultApi.md#delete_release) | **DELETE** /release/{id} |
+*DefaultApi* | [**delete_work**](docs/DefaultApi.md#delete_work) | **DELETE** /work/{id} |
+*DefaultApi* | [**get_changelog**](docs/DefaultApi.md#get_changelog) | **GET** /changelog |
+*DefaultApi* | [**get_changelog_entry**](docs/DefaultApi.md#get_changelog_entry) | **GET** /changelog/{id} |
+*DefaultApi* | [**get_container**](docs/DefaultApi.md#get_container) | **GET** /container/{id} |
+*DefaultApi* | [**get_container_history**](docs/DefaultApi.md#get_container_history) | **GET** /container/{id}/history |
+*DefaultApi* | [**get_creator**](docs/DefaultApi.md#get_creator) | **GET** /creator/{id} |
+*DefaultApi* | [**get_creator_history**](docs/DefaultApi.md#get_creator_history) | **GET** /creator/{id}/history |
+*DefaultApi* | [**get_creator_releases**](docs/DefaultApi.md#get_creator_releases) | **GET** /creator/{id}/releases |
+*DefaultApi* | [**get_editgroup**](docs/DefaultApi.md#get_editgroup) | **GET** /editgroup/{id} |
+*DefaultApi* | [**get_editor**](docs/DefaultApi.md#get_editor) | **GET** /editor/{id} |
+*DefaultApi* | [**get_editor_changelog**](docs/DefaultApi.md#get_editor_changelog) | **GET** /editor/{id}/changelog |
+*DefaultApi* | [**get_file**](docs/DefaultApi.md#get_file) | **GET** /file/{id} |
+*DefaultApi* | [**get_file_history**](docs/DefaultApi.md#get_file_history) | **GET** /file/{id}/history |
+*DefaultApi* | [**get_release**](docs/DefaultApi.md#get_release) | **GET** /release/{id} |
+*DefaultApi* | [**get_release_files**](docs/DefaultApi.md#get_release_files) | **GET** /release/{id}/files |
+*DefaultApi* | [**get_release_history**](docs/DefaultApi.md#get_release_history) | **GET** /release/{id}/history |
+*DefaultApi* | [**get_stats**](docs/DefaultApi.md#get_stats) | **GET** /stats |
+*DefaultApi* | [**get_work**](docs/DefaultApi.md#get_work) | **GET** /work/{id} |
+*DefaultApi* | [**get_work_history**](docs/DefaultApi.md#get_work_history) | **GET** /work/{id}/history |
+*DefaultApi* | [**get_work_releases**](docs/DefaultApi.md#get_work_releases) | **GET** /work/{id}/releases |
+*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/{id} |
+*DefaultApi* | [**update_creator**](docs/DefaultApi.md#update_creator) | **PUT** /creator/{id} |
+*DefaultApi* | [**update_file**](docs/DefaultApi.md#update_file) | **PUT** /file/{id} |
+*DefaultApi* | [**update_release**](docs/DefaultApi.md#update_release) | **PUT** /release/{id} |
+*DefaultApi* | [**update_work**](docs/DefaultApi.md#update_work) | **PUT** /work/{id} |
+
+
+## Documentation For Models
+
+ - [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)
+ - [ReleaseContrib](docs/ReleaseContrib.md)
+ - [ReleaseEntity](docs/ReleaseEntity.md)
+ - [ReleaseEntityAbstracts](docs/ReleaseEntityAbstracts.md)
+ - [ReleaseRef](docs/ReleaseRef.md)
+ - [StatsResponse](docs/StatsResponse.md)
+ - [Success](docs/Success.md)
+ - [WorkEntity](docs/WorkEntity.md)
+
+
+## Documentation For Authorization
+
+ All endpoints do not require authorization.
+
+
+## Author
+
+
+