https://github.com/mahmudindev/oreno-comicbagi-openapi-python
Python-based generated ComicBagi OpenAPI client.
https://github.com/mahmudindev/oreno-comicbagi-openapi-python
client comics openapi sdk
Last synced: 7 months ago
JSON representation
Python-based generated ComicBagi OpenAPI client.
- Host: GitHub
- URL: https://github.com/mahmudindev/oreno-comicbagi-openapi-python
- Owner: mahmudindev
- Created: 2024-10-09T07:30:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T07:17:44.000Z (over 1 year ago)
- Last Synced: 2025-04-09T14:43:41.111Z (12 months ago)
- Topics: client, comics, openapi, sdk
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# comicbagi-openapi
PHP Symfony-based comic hosting catalog full-stack.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.0.1
- Package version: 0.0.1
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```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 comicbagi_openapi
```
### 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 comicbagi_openapi
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import comicbagi_openapi
from comicbagi_openapi.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = comicbagi_openapi.Configuration(
host = "/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): BearerAuth
configuration = comicbagi_openapi.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with comicbagi_openapi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = comicbagi_openapi.ComicApi(api_client)
new_comic = comicbagi_openapi.NewComic() # NewComic |
try:
# Add comic.
api_response = api_instance.add_comic(new_comic)
print("The response of ComicApi->add_comic:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ComicApi->add_comic: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to */api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ComicApi* | [**add_comic**](docs/ComicApi.md#add_comic) | **POST** /rest/comics | Add comic.
*ComicApi* | [**add_comic_destination_link**](docs/ComicApi.md#add_comic_destination_link) | **POST** /rest/comics/{comicCode}/destination-links | Add comic destination link.
*ComicApi* | [**delete_comic**](docs/ComicApi.md#delete_comic) | **DELETE** /rest/comics/{code} | Delete comic.
*ComicApi* | [**delete_comic_destination_link**](docs/ComicApi.md#delete_comic_destination_link) | **DELETE** /rest/comics/{comicCode}/destination-links/{ulid} | Delete comic destination link.
*ComicApi* | [**get_comic**](docs/ComicApi.md#get_comic) | **GET** /rest/comics/{code} | Get comic.
*ComicApi* | [**get_comic_destination_link**](docs/ComicApi.md#get_comic_destination_link) | **GET** /rest/comics/{comicCode}/destination-links/{ulid} | Get comic destination link.
*ComicApi* | [**list_comic**](docs/ComicApi.md#list_comic) | **GET** /rest/comics | List comic.
*ComicApi* | [**list_comic_destination_link**](docs/ComicApi.md#list_comic_destination_link) | **GET** /rest/comics/{comicCode}/destination-links | List comic destination link.
*ComicApi* | [**update_comic**](docs/ComicApi.md#update_comic) | **PATCH** /rest/comics/{code} | Update comic.
*ComicApi* | [**update_comic_destination_link**](docs/ComicApi.md#update_comic_destination_link) | **PATCH** /rest/comics/{comicCode}/destination-links/{ulid} | Update comic destination link.
*ComicChapterApi* | [**add_comic_chapter**](docs/ComicChapterApi.md#add_comic_chapter) | **POST** /rest/comics/{comicCode}/chapters | Add comic chapter.
*ComicChapterApi* | [**add_comic_chapter_destination_link**](docs/ComicChapterApi.md#add_comic_chapter_destination_link) | **POST** /rest/comics/{comicCode}/chapters/{chapterNV}/destination-links | Add comic chapter destination link.
*ComicChapterApi* | [**delete_comic_chapter**](docs/ComicChapterApi.md#delete_comic_chapter) | **DELETE** /rest/comics/{comicCode}/chapters/{nv} | Delete comic chapter.
*ComicChapterApi* | [**delete_comic_chapter_destination_link**](docs/ComicChapterApi.md#delete_comic_chapter_destination_link) | **DELETE** /rest/comics/{comicCode}/chapters/{chapterNV}/destination-links/{ulid} | Delete comic chapter destination link.
*ComicChapterApi* | [**get_comic_chapter**](docs/ComicChapterApi.md#get_comic_chapter) | **GET** /rest/comics/{comicCode}/chapters/{nv} | Get comic chapter.
*ComicChapterApi* | [**get_comic_chapter_destination_link**](docs/ComicChapterApi.md#get_comic_chapter_destination_link) | **GET** /rest/comics/{comicCode}/chapters/{chapterNV}/destination-links/{ulid} | Get comic chapter destination link.
*ComicChapterApi* | [**list_comic_chapter**](docs/ComicChapterApi.md#list_comic_chapter) | **GET** /rest/comics/{comicCode}/chapters | List comic chapter.
*ComicChapterApi* | [**list_comic_chapter_destination_link**](docs/ComicChapterApi.md#list_comic_chapter_destination_link) | **GET** /rest/comics/{comicCode}/chapters/{chapterNV}/destination-links | List comic chapter destination link.
*ComicChapterApi* | [**update_comic_chapter**](docs/ComicChapterApi.md#update_comic_chapter) | **PATCH** /rest/comics/{comicCode}/chapters/{nv} | Update comic chapter.
*ComicChapterApi* | [**update_comic_chapter_destination_link**](docs/ComicChapterApi.md#update_comic_chapter_destination_link) | **PATCH** /rest/comics/{comicCode}/chapters/{chapterNV}/destination-links/{ulid} | Update comic chapter destination link.
*LanguageApi* | [**add_language**](docs/LanguageApi.md#add_language) | **POST** /rest/languages | Add language.
*LanguageApi* | [**delete_language**](docs/LanguageApi.md#delete_language) | **DELETE** /rest/languages/{lang} | Delete language.
*LanguageApi* | [**get_language**](docs/LanguageApi.md#get_language) | **GET** /rest/languages/{lang} | Get language.
*LanguageApi* | [**list_language**](docs/LanguageApi.md#list_language) | **GET** /rest/languages | List language.
*LanguageApi* | [**update_language**](docs/LanguageApi.md#update_language) | **PATCH** /rest/languages/{lang} | Update language.
*LinkApi* | [**add_link**](docs/LinkApi.md#add_link) | **POST** /rest/links | Add link.
*LinkApi* | [**add_link_item_language**](docs/LinkApi.md#add_link_item_language) | **POST** /rest/links/{linkHref}/item-languages | Add link item language.
*LinkApi* | [**delete_link**](docs/LinkApi.md#delete_link) | **DELETE** /rest/links/{href} | Delete link.
*LinkApi* | [**delete_link_item_language**](docs/LinkApi.md#delete_link_item_language) | **DELETE** /rest/links/{linkHref}/item-languages/{lang} | Delete link item language.
*LinkApi* | [**get_link**](docs/LinkApi.md#get_link) | **GET** /rest/links/{href} | Get link.
*LinkApi* | [**get_link_item_language**](docs/LinkApi.md#get_link_item_language) | **GET** /rest/links/{linkHref}/item-languages/{lang} | Get link item language.
*LinkApi* | [**list_link**](docs/LinkApi.md#list_link) | **GET** /rest/links | List link.
*LinkApi* | [**list_link_item_language**](docs/LinkApi.md#list_link_item_language) | **GET** /rest/links/{linkHref}/item-languages | List link item language.
*LinkApi* | [**update_link**](docs/LinkApi.md#update_link) | **PATCH** /rest/links/{href} | Update link.
*LinkApi* | [**update_link_item_language**](docs/LinkApi.md#update_link_item_language) | **PATCH** /rest/links/{linkHref}/item-languages/{lang} | Update link item language.
*WebsiteApi* | [**add_website**](docs/WebsiteApi.md#add_website) | **POST** /rest/websites | Add website.
*WebsiteApi* | [**add_website_item_language**](docs/WebsiteApi.md#add_website_item_language) | **POST** /rest/websites/{websiteHost}/item-languages | Add website item language.
*WebsiteApi* | [**delete_website**](docs/WebsiteApi.md#delete_website) | **DELETE** /rest/websites/{host} | Delete website.
*WebsiteApi* | [**delete_website_item_language**](docs/WebsiteApi.md#delete_website_item_language) | **DELETE** /rest/websites/{websiteHost}/item-languages/{lang} | Delete website item language.
*WebsiteApi* | [**get_website**](docs/WebsiteApi.md#get_website) | **GET** /rest/websites/{host} | Get website.
*WebsiteApi* | [**get_website_item_language**](docs/WebsiteApi.md#get_website_item_language) | **GET** /rest/websites/{websiteHost}/item-languages/{lang} | Get website item language.
*WebsiteApi* | [**list_website**](docs/WebsiteApi.md#list_website) | **GET** /rest/websites | List website.
*WebsiteApi* | [**list_website_item_language**](docs/WebsiteApi.md#list_website_item_language) | **GET** /rest/websites/{websiteHost}/item-languages | List website item language.
*WebsiteApi* | [**update_website**](docs/WebsiteApi.md#update_website) | **PATCH** /rest/websites/{host} | Update website.
*WebsiteApi* | [**update_website_item_language**](docs/WebsiteApi.md#update_website_item_language) | **PATCH** /rest/websites/{websiteHost}/item-languages/{lang} | Update website item language.
## Documentation For Models
- [Comic](docs/Comic.md)
- [ComicChapter](docs/ComicChapter.md)
- [ComicChapterDestinationLink](docs/ComicChapterDestinationLink.md)
- [ComicDestinationLink](docs/ComicDestinationLink.md)
- [Error](docs/Error.md)
- [Language](docs/Language.md)
- [Link](docs/Link.md)
- [LinkItemLanguage](docs/LinkItemLanguage.md)
- [NewComic](docs/NewComic.md)
- [NewComicChapter](docs/NewComicChapter.md)
- [NewComicChapterDestinationLink](docs/NewComicChapterDestinationLink.md)
- [NewComicDestinationLink](docs/NewComicDestinationLink.md)
- [NewLanguage](docs/NewLanguage.md)
- [NewLink](docs/NewLink.md)
- [NewLinkItemLanguage](docs/NewLinkItemLanguage.md)
- [NewWebsite](docs/NewWebsite.md)
- [NewWebsiteItemLanguage](docs/NewWebsiteItemLanguage.md)
- [SetComic](docs/SetComic.md)
- [SetComicChapter](docs/SetComicChapter.md)
- [SetComicChapterDestinationLink](docs/SetComicChapterDestinationLink.md)
- [SetComicDestinationLink](docs/SetComicDestinationLink.md)
- [SetLanguage](docs/SetLanguage.md)
- [SetLink](docs/SetLink.md)
- [SetLinkItemLanguage](docs/SetLinkItemLanguage.md)
- [SetWebsite](docs/SetWebsite.md)
- [SetWebsiteItemLanguage](docs/SetWebsiteItemLanguage.md)
- [Website](docs/Website.md)
- [WebsiteItemLanguage](docs/WebsiteItemLanguage.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### BearerAuth
- **Type**: Bearer authentication (JWT)
## Author