Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/incognito/python_studio_ghibli_api_sdk
Studio Ghibli API in Python from swagger-codegen
https://github.com/incognito/python_studio_ghibli_api_sdk
Last synced: 17 days ago
JSON representation
Studio Ghibli API in Python from swagger-codegen
- Host: GitHub
- URL: https://github.com/incognito/python_studio_ghibli_api_sdk
- Owner: Incognito
- License: other
- Created: 2018-06-02T16:24:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-02T18:03:35.000Z (over 6 years ago)
- Last Synced: 2024-10-30T01:48:43.060Z (2 months ago)
- Language: Python
- Homepage: https://pypi.org/project/studio_ghibli_api_sdk
- Size: 67.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# studio_ghibli_api_sdk
https://pypi.org/project/studio_ghibli_api_sdk/
[](https://travis-ci.org/Incognito/python_studio_ghibli_api_sdk)
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.1
- Package version: 1.0.3
- 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 studio_ghibli_api_sdk
```
### 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 studio_ghibli_api_sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import studio_ghibli_api_sdk
from studio_ghibli_api_sdk.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = studio_ghibli_api_sdk.FilmsApi()
fields = 'fields_example' # str | comma-separated list of fields to include in the response (optional)
limit = 789 # int | amount of results (default 50) (maximum 250) (optional)
try:
# Return all films
api_response = api_instance.films_get(fields=fields, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling FilmsApi->films_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://ghibliapi.herokuapp.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FilmsApi* | [**films_get**](docs/FilmsApi.md#films_get) | **GET** /films | Return all films
*FilmsApi* | [**films_id_get**](docs/FilmsApi.md#films_id_get) | **GET** /films/{id} | Film ID
*LocationsApi* | [**locations_get**](docs/LocationsApi.md#locations_get) | **GET** /locations | Return all locations
*LocationsApi* | [**locations_id_get**](docs/LocationsApi.md#locations_id_get) | **GET** /locations/{id} | Location ID
*PeopleApi* | [**people_get**](docs/PeopleApi.md#people_get) | **GET** /people | Return all people
*PeopleApi* | [**people_id_get**](docs/PeopleApi.md#people_id_get) | **GET** /people/{id} | People ID
*SpeciesApi* | [**species_get**](docs/SpeciesApi.md#species_get) | **GET** /species | Species
*SpeciesApi* | [**species_id_get**](docs/SpeciesApi.md#species_id_get) | **GET** /species/{id} | Species ID
*VehiclesApi* | [**vehicles_get**](docs/VehiclesApi.md#vehicles_get) | **GET** /vehicles | Vehicles
*VehiclesApi* | [**vehicles_id_get**](docs/VehiclesApi.md#vehicles_id_get) | **GET** /vehicles/{id} | Vehicle ID
## Documentation For Models
- [Error](docs/Error.md)
- [Films](docs/Films.md)
- [Locations](docs/Locations.md)
- [People](docs/People.md)
- [Species](docs/Species.md)
- [Vehicles](docs/Vehicles.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author