blob: 6d4361605e817ca436ba7e6f5657535e23f3cf2b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# 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 = 789 # int |
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* | [**get_container**](docs/DefaultApi.md#get_container) | **GET** /container/{id} |
*DefaultApi* | [**get_creator**](docs/DefaultApi.md#get_creator) | **GET** /creator/{id} |
*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/{username} |
*DefaultApi* | [**get_editor_changelog**](docs/DefaultApi.md#get_editor_changelog) | **GET** /editor/{username}/changelog |
*DefaultApi* | [**get_file**](docs/DefaultApi.md#get_file) | **GET** /file/{id} |
*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_stats**](docs/DefaultApi.md#get_stats) | **GET** /stats |
*DefaultApi* | [**get_work**](docs/DefaultApi.md#get_work) | **GET** /work/{id} |
*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 |
## Documentation For Models
- [Changelogentries](docs/Changelogentries.md)
- [ChangelogentriesInner](docs/ChangelogentriesInner.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)
- [ErrorResponse](docs/ErrorResponse.md)
- [FileEntity](docs/FileEntity.md)
- [ReleaseContrib](docs/ReleaseContrib.md)
- [ReleaseEntity](docs/ReleaseEntity.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
|
