Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uclouvain/osis-internship-sdk
SDK package for internship api communication
https://github.com/uclouvain/osis-internship-sdk
Last synced: 10 days ago
JSON representation
SDK package for internship api communication
- Host: GitHub
- URL: https://github.com/uclouvain/osis-internship-sdk
- Owner: uclouvain
- Created: 2021-01-14T10:17:32.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T07:59:54.000Z (9 months ago)
- Last Synced: 2024-11-14T21:11:47.840Z (2 months ago)
- Language: Python
- Size: 810 KB
- Stars: 0
- Watchers: 16
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# osis_internship_sdk
This API delivers data for the Internship project.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/uclouvain/osis](https://github.com/uclouvain/osis)
## 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 osis_internship_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 osis_internship_sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import osis_internship_sdk
from osis_internship_sdk.rest import ApiException
from pprint import pprint
# Configure API key authorization: Token
configuration = osis_internship_sdk.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = osis_internship_sdk.DefaultApi(osis_internship_sdk.ApiClient(configuration))
try:
api_response = api_instance.cohorts_get()
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->cohorts_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://dev.osis.uclouvain.be/api/v1/internship*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**cohorts_get**](docs/DefaultApi.md#cohorts_get) | **GET** /cohorts |
*DefaultApi* | [**cohorts_uuid_get**](docs/DefaultApi.md#cohorts_uuid_get) | **GET** /cohorts/{uuid} |
*DefaultApi* | [**internships_get**](docs/DefaultApi.md#internships_get) | **GET** /internships |
*DefaultApi* | [**internships_uuid_get**](docs/DefaultApi.md#internships_uuid_get) | **GET** /internships/{uuid} |
*DefaultApi* | [**masters_allocations_uuid_get**](docs/DefaultApi.md#masters_allocations_uuid_get) | **GET** /masters_allocations/{uuid} |
*DefaultApi* | [**masters_get**](docs/DefaultApi.md#masters_get) | **GET** /masters |
*DefaultApi* | [**masters_uuid_activate_account_put**](docs/DefaultApi.md#masters_uuid_activate_account_put) | **PUT** /masters/{uuid}/activate_account/ |
*DefaultApi* | [**masters_uuid_allocations_get**](docs/DefaultApi.md#masters_uuid_allocations_get) | **GET** /masters/{uuid}/allocations/ |
*DefaultApi* | [**masters_uuid_get**](docs/DefaultApi.md#masters_uuid_get) | **GET** /masters/{uuid} |
*DefaultApi* | [**organizations_get**](docs/DefaultApi.md#organizations_get) | **GET** /organizations |
*DefaultApi* | [**organizations_uuid_get**](docs/DefaultApi.md#organizations_uuid_get) | **GET** /organizations/{uuid} |
*DefaultApi* | [**periods_get**](docs/DefaultApi.md#periods_get) | **GET** /periods |
*DefaultApi* | [**periods_uuid_get**](docs/DefaultApi.md#periods_uuid_get) | **GET** /periods/{uuid} |
*DefaultApi* | [**scores_student_uuid_period_uuid_get**](docs/DefaultApi.md#scores_student_uuid_period_uuid_get) | **GET** /scores/{student_uuid}/{period_uuid} |
*DefaultApi* | [**scores_student_uuid_period_uuid_put**](docs/DefaultApi.md#scores_student_uuid_period_uuid_put) | **PUT** /scores/{student_uuid}/{period_uuid} |
*DefaultApi* | [**specialties_get**](docs/DefaultApi.md#specialties_get) | **GET** /specialties |
*DefaultApi* | [**specialties_uuid_get**](docs/DefaultApi.md#specialties_uuid_get) | **GET** /specialties/{uuid} |
*DefaultApi* | [**students_affectations_specialty_organization_get**](docs/DefaultApi.md#students_affectations_specialty_organization_get) | **GET** /students_affectations/{specialty}/{organization} |
*DefaultApi* | [**students_affectations_uuid_get**](docs/DefaultApi.md#students_affectations_uuid_get) | **GET** /students_affectations/{uuid} |
*DefaultApi* | [**students_get**](docs/DefaultApi.md#students_get) | **GET** /students |
*DefaultApi* | [**students_uuid_get**](docs/DefaultApi.md#students_uuid_get) | **GET** /students/{uuid} |
## Documentation For Models
- [AllocationGet](docs/AllocationGet.md)
- [CohortGet](docs/CohortGet.md)
- [Country](docs/Country.md)
- [InternshipGet](docs/InternshipGet.md)
- [MasterGet](docs/MasterGet.md)
- [OrganizationGet](docs/OrganizationGet.md)
- [Paging](docs/Paging.md)
- [PeriodGet](docs/PeriodGet.md)
- [Person](docs/Person.md)
- [ScoreGet](docs/ScoreGet.md)
- [SpecialtyGet](docs/SpecialtyGet.md)
- [Student](docs/Student.md)
- [StudentAffectationGet](docs/StudentAffectationGet.md)
- [StudentGet](docs/StudentGet.md)
## Documentation For Authorization
## Token
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author