Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uclouvain/osis-attribution-sdk
SDK package for attribution api communication
https://github.com/uclouvain/osis-attribution-sdk
Last synced: about 2 months ago
JSON representation
SDK package for attribution api communication
- Host: GitHub
- URL: https://github.com/uclouvain/osis-attribution-sdk
- Owner: uclouvain
- Created: 2021-01-21T06:56:43.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T14:38:40.000Z (over 1 year ago)
- Last Synced: 2024-06-19T00:21:58.413Z (7 months ago)
- Language: Python
- Size: 228 KB
- Stars: 0
- Watchers: 16
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi-client
A set of API endpoints that allow you to get information about attribution
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.00
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen
## Requirements.
Python 2.7 and 3.4+
## 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 openapi_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 openapi_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://dev.osis.uclouvain.be/api/v1/attribution
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://dev.osis.uclouvain.be/api/v1/attribution"
)
# 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 API key authorization: Token
configuration.api_key['Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.ApplicationApi(api_client)
try:
api_response = api_instance.applicationcoursescalendars_list()
pprint(api_response)
except ApiException as e:
print("Exception when calling ApplicationApi->applicationcoursescalendars_list: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://dev.osis.uclouvain.be/api/v1/attribution*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApplicationApi* | [**applicationcoursescalendars_list**](docs/ApplicationApi.md#applicationcoursescalendars_list) | **GET** /application/calendars |
## Documentation For Models
- [ApplicationCourseCalendar](docs/ApplicationCourseCalendar.md)
- [Error](docs/Error.md)
## Documentation For Authorization
## Token
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author