aboutsummaryrefslogtreecommitdiffstats
path: root/python_openapi_client/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/README.md')
-rw-r--r--python_openapi_client/README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/python_openapi_client/README.md b/python_openapi_client/README.md
index fdd7e84d..4682a596 100644
--- a/python_openapi_client/README.md
+++ b/python_openapi_client/README.md
@@ -1,11 +1,11 @@
# 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 [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.3.1
- Package version: 0.3.1
-- Build package: io.swagger.codegen.languages.PythonClientCodegen
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://fatcat.wiki](https://fatcat.wiki)
## Requirements.
@@ -15,7 +15,7 @@ Python 2.7 and 3.5+
## Installation & Usage
### pip install
-If the python package is hosted on Github, you can install directly from Github
+If the python package is hosted on a repository, you can install directly using:
```sh
pip install fatcat-openapi-client
@@ -52,12 +52,16 @@ 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
-fatcat_openapi_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-fatcat_openapi_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
-# create an instance of the API class
-api_instance = fatcat_openapi_client.DefaultApi()
+# 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: