Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uclouvain/osis-education-group-sdk
SDK package for education group api communication
https://github.com/uclouvain/osis-education-group-sdk
Last synced: 10 days ago
JSON representation
SDK package for education group api communication
- Host: GitHub
- URL: https://github.com/uclouvain/osis-education-group-sdk
- Owner: uclouvain
- Created: 2021-09-20T10:23:42.000Z (over 3 years ago)
- Default Branch: build-1.8.0
- Last Pushed: 2024-10-24T10:04:46.000Z (3 months ago)
- Last Synced: 2024-11-14T21:11:49.589Z (2 months ago)
- Language: Python
- Size: 866 KB
- Stars: 0
- Watchers: 16
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# osis-education-group-sdk
A set of API endpoints that allow you to get, update, delete an education group.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.08
- Package version: 1.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >= 3.5
## 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 osis_education_group_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_education_group_sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import osis_education_group_sdk
from pprint import pprint
from osis_education_group_sdk.api import groups_api
from osis_education_group_sdk.model.accepted_language_enum import AcceptedLanguageEnum
from osis_education_group_sdk.model.error import Error
from osis_education_group_sdk.model.group_detailed import GroupDetailed
from osis_education_group_sdk.model.inline_response200 import InlineResponse200
from osis_education_group_sdk.model.tree import Tree
# Defining the host is optional and defaults to https://dev.osis.uclouvain.be/api/v1/education_group
# See configuration.py for a list of all supported configuration parameters.
configuration = osis_education_group_sdk.Configuration(
host = "https://dev.osis.uclouvain.be/api/v1/education_group"
)
# 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 osis_education_group_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = groups_api.GroupsApi(api_client)
year = "year_example" # str |
partial_acronym = "partial_acronym_example" # str |
accept_language = AcceptedLanguageEnum("en") # AcceptedLanguageEnum | The header advertises which languages the client is able to understand, and which locale variant is preferred. (By languages, we mean natural languages, such as English, and not programming languages.) (optional)
x_user_first_name = "X-User-FirstName_example" # str | (optional)
x_user_last_name = "X-User-LastName_example" # str | (optional)
x_user_email = "X-User-Email_example" # str | (optional)
x_user_global_id = "X-User-GlobalID_example" # str | (optional)
try:
api_response = api_instance.groups_read(year, partial_acronym, accept_language=accept_language, x_user_first_name=x_user_first_name, x_user_last_name=x_user_last_name, x_user_email=x_user_email, x_user_global_id=x_user_global_id)
pprint(api_response)
except osis_education_group_sdk.ApiException as e:
print("Exception when calling GroupsApi->groups_read: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://dev.osis.uclouvain.be/api/v1/education_group*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GroupsApi* | [**groups_read**](docs/GroupsApi.md#groups_read) | **GET** /groups/{year}/{partial_acronym} |
*GroupsApi* | [**groups_tree**](docs/GroupsApi.md#groups_tree) | **GET** /groups/{year}/{partial_acronym}/tree |
*GroupsApi* | [**groupstitle_read**](docs/GroupsApi.md#groupstitle_read) | **GET** /groups/{year}/{partial_acronym}/title |
*HabilitationListApi* | [**habilitations_list**](docs/HabilitationListApi.md#habilitations_list) | **GET** /hops/{year} |
*MiniTrainingsApi* | [**mini_training_prerequisites_official**](docs/MiniTrainingsApi.md#mini_training_prerequisites_official) | **GET** /mini_trainings/{year}/{acronym}/prerequisites |
*MiniTrainingsApi* | [**mini_training_version**](docs/MiniTrainingsApi.md#mini_training_version) | **GET** /mini_trainings/{year}/{acronym}/versions/{version_name} |
*MiniTrainingsApi* | [**minitraining_tree**](docs/MiniTrainingsApi.md#minitraining_tree) | **GET** /mini_trainings/{year}/{acronym}/tree |
*MiniTrainingsApi* | [**minitraining_version_tree**](docs/MiniTrainingsApi.md#minitraining_version_tree) | **GET** /mini_trainings/{year}/{acronym}/versions/{version_name}/tree |
*MiniTrainingsApi* | [**minitrainings_list**](docs/MiniTrainingsApi.md#minitrainings_list) | **GET** /mini_trainings/ |
*MiniTrainingsApi* | [**minitrainings_offer_roots**](docs/MiniTrainingsApi.md#minitrainings_offer_roots) | **GET** /mini_trainings/{year}/{acronym}/offer_roots |
*MiniTrainingsApi* | [**minitrainings_read**](docs/MiniTrainingsApi.md#minitrainings_read) | **GET** /mini_trainings/{year}/{acronym} |
*MiniTrainingsApi* | [**minitrainings_title_version_read**](docs/MiniTrainingsApi.md#minitrainings_title_version_read) | **GET** /mini_trainings/{year}/{acronym}/versions/{version_name}/title |
*MiniTrainingsApi* | [**minitrainingstitle_read**](docs/MiniTrainingsApi.md#minitrainingstitle_read) | **GET** /mini_trainings/{year}/{acronym}/title |
*TrainingsApi* | [**training_prerequisites_official**](docs/TrainingsApi.md#training_prerequisites_official) | **GET** /trainings/{year}/{acronym}/prerequisites |
*TrainingsApi* | [**training_version**](docs/TrainingsApi.md#training_version) | **GET** /trainings/{year}/{acronym}/versions/{version_name} |
*TrainingsApi* | [**trainings_list**](docs/TrainingsApi.md#trainings_list) | **GET** /trainings/ |
*TrainingsApi* | [**trainings_offer_roots**](docs/TrainingsApi.md#trainings_offer_roots) | **GET** /trainings/{year}/{acronym}/offer_roots |
*TrainingsApi* | [**trainings_read**](docs/TrainingsApi.md#trainings_read) | **GET** /trainings/{year}/{acronym} |
*TrainingsApi* | [**trainings_tree**](docs/TrainingsApi.md#trainings_tree) | **GET** /trainings/{year}/{acronym}/tree |
*TrainingsApi* | [**trainingstitle_read**](docs/TrainingsApi.md#trainingstitle_read) | **GET** /trainings/{year}/{acronym}/title |
*TrainingsApi* | [**trainingsversiontitle_read**](docs/TrainingsApi.md#trainingsversiontitle_read) | **GET** /trainings/{year}/{acronym}/versions/{version_name}/title |
*TrainingsApi* | [**versions_tree**](docs/TrainingsApi.md#versions_tree) | **GET** /trainings/{year}/{acronym}/versions/{version_name}/tree |
## Documentation For Models
- [AcademicTypeEnum](docs/AcademicTypeEnum.md)
- [AcceptedLanguageEnum](docs/AcceptedLanguageEnum.md)
- [ActiveEnum](docs/ActiveEnum.md)
- [ActivityPresenceEnum](docs/ActivityPresenceEnum.md)
- [ArrayOfProgramTreePrerequisites](docs/ArrayOfProgramTreePrerequisites.md)
- [ArrayOfVersions](docs/ArrayOfVersions.md)
- [Campus](docs/Campus.md)
- [ConstraintTypeEnum](docs/ConstraintTypeEnum.md)
- [DecreeCategoryEnum](docs/DecreeCategoryEnum.md)
- [DurationUnitEnum](docs/DurationUnitEnum.md)
- [Error](docs/Error.md)
- [GroupDetailed](docs/GroupDetailed.md)
- [GroupTypeEnum](docs/GroupTypeEnum.md)
- [Hops](docs/Hops.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [InternshipPresenceEnum](docs/InternshipPresenceEnum.md)
- [LearningUnitTypeEnum](docs/LearningUnitTypeEnum.md)
- [MiniTraining](docs/MiniTraining.md)
- [MiniTrainingDetailed](docs/MiniTrainingDetailed.md)
- [MiniTrainingDetailedAllOf](docs/MiniTrainingDetailedAllOf.md)
- [MiniTrainingTypeEnum](docs/MiniTrainingTypeEnum.md)
- [Node](docs/Node.md)
- [NodeBase](docs/NodeBase.md)
- [NodeLinkTypeEnum](docs/NodeLinkTypeEnum.md)
- [NodeSubTypeEnum](docs/NodeSubTypeEnum.md)
- [NodeTypeEnum](docs/NodeTypeEnum.md)
- [PaginatedMiniTraining](docs/PaginatedMiniTraining.md)
- [PaginatedMiniTrainingAllOf](docs/PaginatedMiniTrainingAllOf.md)
- [PaginatedTraining](docs/PaginatedTraining.md)
- [PaginatedTrainingAllOf](docs/PaginatedTrainingAllOf.md)
- [Pagination](docs/Pagination.md)
- [PeriodicityEnum](docs/PeriodicityEnum.md)
- [PrintOrientationEnum](docs/PrintOrientationEnum.md)
- [ProgramTreePrerequisites](docs/ProgramTreePrerequisites.md)
- [ProposalTypeEnum](docs/ProposalTypeEnum.md)
- [QuadrimesterEnum](docs/QuadrimesterEnum.md)
- [RateCodeEnum](docs/RateCodeEnum.md)
- [ScheduleTypeEnum](docs/ScheduleTypeEnum.md)
- [Training](docs/Training.md)
- [TrainingDetailed](docs/TrainingDetailed.md)
- [TrainingDetailedAllOf](docs/TrainingDetailedAllOf.md)
- [TrainingTypeEnum](docs/TrainingTypeEnum.md)
- [Tree](docs/Tree.md)
- [Version](docs/Version.md)
## Documentation For Authorization
## Token
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in osis_education_group_sdk.apis and osis_education_group_sdk.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from osis_education_group_sdk.api.default_api import DefaultApi`
- `from osis_education_group_sdk.model.pet import Pet`
Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import osis_education_group_sdk
from osis_education_group_sdk.apis import *
from osis_education_group_sdk.models import *
```