{"id":21553113,"url":"https://github.com/flatio/api-client-python","last_synced_at":"2025-04-10T07:50:06.039Z","repository":{"id":19715554,"uuid":"87713658","full_name":"FlatIO/api-client-python","owner":"FlatIO","description":"🐍 Python client for the Flat REST API","archived":false,"fork":false,"pushed_at":"2024-03-08T20:27:20.000Z","size":1511,"stargazers_count":9,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T00:57:00.177Z","etag":null,"topics":["api-client","education","flat-api","midi","music-notation","musicxml","python","python-client","score"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FlatIO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-09T14:17:48.000Z","updated_at":"2024-10-24T06:52:01.000Z","dependencies_parsed_at":"2023-02-10T06:00:28.185Z","dependency_job_id":null,"html_url":"https://github.com/FlatIO/api-client-python","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlatIO%2Fapi-client-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlatIO","download_url":"https://codeload.github.com/FlatIO/api-client-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248182010,"owners_count":21060891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","education","flat-api","midi","music-notation","musicxml","python","python-client","score"],"created_at":"2024-11-24T07:09:33.264Z","updated_at":"2025-04-10T07:50:06.015Z","avatar_url":"https://github.com/FlatIO.png","language":"Python","readme":"# Python Client for the Flat REST API\n\n[![Python package](https://github.com/FlatIO/api-client-python/actions/workflows/python.yml/badge.svg)](https://github.com/FlatIO/api-client-python/actions/workflows/python.yml)\n\nThe Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:\n- Creating and importing new music scores using MusicXML or MIDI files\n- Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI)\n- Managing educational resources with Flat for Education: creating \u0026 updating the organization accounts, the classes, rosters and assignments.\n\nYou can find the API reference including code samples and our OpenAPI Specification at the following url: [https://flat.io/developers/api/reference](https://flat.io/developers/api/reference).\n\nTo request some API credentials, please visit [https://flat.io/developers](https://flat.io/developers).\n\n## Requirements.\n\nPython \u003e= 3.7\n\n## Installation \u0026 Usage\n### pip install\n\n```sh\npip install flat_api\n```\n\nor install from this repository\n\n```sh\npip install git+https://github.com/FlatIO/api-client-python.git\n```\n\nThen import the package:\n```python\nimport flat_api\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport flat_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom pprint import pprint\nimport flat_api\nfrom flat_api.api import account_api\n\nconfiguration = flat_api.Configuration(\n    access_token = 'YOUR_ACCESS_TOKEN'\n)\n\n# Enter a context with an instance of the API client\nwith flat_api.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = account_api.AccountApi(api_client)\n\n    try:\n        # Get current user account\n        api_response = api_instance.get_authenticated_user()\n        pprint(api_response)\n    except flat_api.ApiException as e:\n        print(\"Exception when calling AccountApi-\u003eget_authenticated_user: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.flat.io/v2*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountApi* | [**get_authenticated_user**](docs/AccountApi.md#get_authenticated_user) | **GET** /me | Get current user account\n*ClassApi* | [**activate_class**](docs/ClassApi.md#activate_class) | **POST** /classes/{class}/activate | Activate the class\n*ClassApi* | [**add_class_user**](docs/ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class\n*ClassApi* | [**archive_assignment**](docs/ClassApi.md#archive_assignment) | **POST** /classes/{class}/assignments/{assignment}/archive | Archive the assignment\n*ClassApi* | [**archive_class**](docs/ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class\n*ClassApi* | [**copy_assignment**](docs/ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment\n*ClassApi* | [**create_class**](docs/ClassApi.md#create_class) | **POST** /classes | Create a new class\n*ClassApi* | [**create_class_assignment**](docs/ClassApi.md#create_class_assignment) | **POST** /classes/{class}/assignments | Assignment creation\n*ClassApi* | [**create_submission**](docs/ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission\n*ClassApi* | [**create_test_student_account**](docs/ClassApi.md#create_test_student_account) | **POST** /classes/{class}/testStudent | Create a test student account\n*ClassApi* | [**delete_class_user**](docs/ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class\n*ClassApi* | [**delete_submission**](docs/ClassApi.md#delete_submission) | **DELETE** /classes/{class}/assignments/{assignment}/submissions/{submission} | Reset a submission\n*ClassApi* | [**delete_submission_comment**](docs/ClassApi.md#delete_submission_comment) | **DELETE** /classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment} | Delete a feedback comment to a submission\n*ClassApi* | [**edit_submission**](docs/ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission\n*ClassApi* | [**enroll_class**](docs/ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class\n*ClassApi* | [**export_submissions_reviews_as_csv**](docs/ClassApi.md#export_submissions_reviews_as_csv) | **GET** /classes/{class}/assignments/{assignment}/submissions/csv | CSV Grades exports\n*ClassApi* | [**export_submissions_reviews_as_excel**](docs/ClassApi.md#export_submissions_reviews_as_excel) | **GET** /classes/{class}/assignments/{assignment}/submissions/excel | Excel Grades exports\n*ClassApi* | [**get_class**](docs/ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class\n*ClassApi* | [**get_score_submissions**](docs/ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*ClassApi* | [**get_submission**](docs/ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission\n*ClassApi* | [**get_submission_comments**](docs/ClassApi.md#get_submission_comments) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission}/comments | List the feedback comments of a submission\n*ClassApi* | [**get_submission_history**](docs/ClassApi.md#get_submission_history) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission}/history | Get the history of the submission\n*ClassApi* | [**get_submissions**](docs/ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students\u0026#39; submissions\n*ClassApi* | [**list_assignments**](docs/ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing\n*ClassApi* | [**list_class_student_submissions**](docs/ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student\n*ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user\n*ClassApi* | [**post_submission_comment**](docs/ClassApi.md#post_submission_comment) | **POST** /classes/{class}/assignments/{assignment}/submissions/{submission}/comments | Add a feedback comment to a submission\n*ClassApi* | [**unarchive_assignment**](docs/ClassApi.md#unarchive_assignment) | **DELETE** /classes/{class}/assignments/{assignment}/archive | Unarchive the assignment.\n*ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class\n*ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class\n*ClassApi* | [**update_submission_comment**](docs/ClassApi.md#update_submission_comment) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission}/comments/{comment} | Update a feedback comment to a submission\n*CollectionApi* | [**add_score_to_collection**](docs/CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection\n*CollectionApi* | [**create_collection**](docs/CollectionApi.md#create_collection) | **POST** /collections | Create a new collection\n*CollectionApi* | [**delete_collection**](docs/CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection\n*CollectionApi* | [**delete_score_from_collection**](docs/CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection\n*CollectionApi* | [**edit_collection**](docs/CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection\u0026#39;s metadata\n*CollectionApi* | [**get_collection**](docs/CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details\n*CollectionApi* | [**list_collection_scores**](docs/CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection\n*CollectionApi* | [**list_collections**](docs/CollectionApi.md#list_collections) | **GET** /collections | List the collections\n*CollectionApi* | [**untrash_collection**](docs/CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection\n*EduResourcesApi* | [**copy_edu_resource**](docs/EduResourcesApi.md#copy_edu_resource) | **POST** /eduResources/{resource}/copy | Copy an education resource to a Resource Library\n*EduResourcesApi* | [**copy_edu_resource_to_demo_class**](docs/EduResourcesApi.md#copy_edu_resource_to_demo_class) | **POST** /eduResources/{resource}/copyToDemoClass | Copy an education assignment to a teacher demo class\n*EduResourcesApi* | [**create_edu_resource**](docs/EduResourcesApi.md#create_edu_resource) | **POST** /eduResources | Create a new education resource\n*EduResourcesApi* | [**delete_edu_resource**](docs/EduResourcesApi.md#delete_edu_resource) | **DELETE** /eduResources/{resource} | Delete an education resource\n*EduResourcesApi* | [**get_edu_resource**](docs/EduResourcesApi.md#get_edu_resource) | **GET** /eduResources/{resource} | Get an education resource\n*EduResourcesApi* | [**list_edu_libraries**](docs/EduResourcesApi.md#list_edu_libraries) | **GET** /eduResources/libraries | List the education libraries\n*EduResourcesApi* | [**list_edu_resources**](docs/EduResourcesApi.md#list_edu_resources) | **GET** /eduResources | List education resources in a library or folder\n*EduResourcesApi* | [**move_edu_resource**](docs/EduResourcesApi.md#move_edu_resource) | **POST** /eduResources/{resource}/move | Move an education resource\n*EduResourcesApi* | [**update_edu_resource**](docs/EduResourcesApi.md#update_edu_resource) | **PUT** /eduResources/{resource} | Update an education resource metadata\n*EduResourcesApi* | [**update_edu_resource_assignment**](docs/EduResourcesApi.md#update_edu_resource_assignment) | **PUT** /eduResources/{resource}/assignment | Update an education resource assignment\n*EduResourcesApi* | [**use_edu_resource_in_class**](docs/EduResourcesApi.md#use_edu_resource_in_class) | **POST** /eduResources/{resource}/useInClass | Use an education resource in a class\n*GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information\n*GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group\u0026#39;s users\n*OrganizationApi* | [**count_orga_users**](docs/OrganizationApi.md#count_orga_users) | **GET** /organizations/users/count | Count the organization users using the provided filters\n*OrganizationApi* | [**create_lti_credentials**](docs/OrganizationApi.md#create_lti_credentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials\n*OrganizationApi* | [**create_organization_invitation**](docs/OrganizationApi.md#create_organization_invitation) | **POST** /organizations/invitations | Create a new invitation to join the organization\n*OrganizationApi* | [**create_organization_user**](docs/OrganizationApi.md#create_organization_user) | **POST** /organizations/users | Create a new user account\n*OrganizationApi* | [**create_organization_user_access_token**](docs/OrganizationApi.md#create_organization_user_access_token) | **POST** /organizations/users/{user}/accessToken | Create a delegated API access token for an organization user\n*OrganizationApi* | [**create_organization_user_signin_link**](docs/OrganizationApi.md#create_organization_user_signin_link) | **POST** /organizations/users/{user}/signinLink | Create a sign in link for an organization user\n*OrganizationApi* | [**list_lti_credentials**](docs/OrganizationApi.md#list_lti_credentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials\n*OrganizationApi* | [**list_organization_invitations**](docs/OrganizationApi.md#list_organization_invitations) | **GET** /organizations/invitations | List the organization invitations\n*OrganizationApi* | [**list_organization_users**](docs/OrganizationApi.md#list_organization_users) | **GET** /organizations/users | List the organization users\n*OrganizationApi* | [**remove_organization_invitation**](docs/OrganizationApi.md#remove_organization_invitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation\n*OrganizationApi* | [**remove_organization_user**](docs/OrganizationApi.md#remove_organization_user) | **DELETE** /organizations/users/{user} | Remove an account from Flat\n*OrganizationApi* | [**revoke_lti_credentials**](docs/OrganizationApi.md#revoke_lti_credentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials\n*OrganizationApi* | [**update_organization_user**](docs/OrganizationApi.md#update_organization_user) | **PUT** /organizations/users/{user} | Update account information\n*ScoreApi* | [**add_score_collaborator**](docs/ScoreApi.md#add_score_collaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator\n*ScoreApi* | [**add_score_track**](docs/ScoreApi.md#add_score_track) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score\n*ScoreApi* | [**create_export_task**](docs/ScoreApi.md#create_export_task) | **POST** /scores/{score}/revisions/{revision}/{format}/task | Create a new score export task\n*ScoreApi* | [**create_score**](docs/ScoreApi.md#create_score) | **POST** /scores | Create a new score\n*ScoreApi* | [**create_score_revision**](docs/ScoreApi.md#create_score_revision) | **POST** /scores/{score}/revisions | Create a new revision\n*ScoreApi* | [**delete_score**](docs/ScoreApi.md#delete_score) | **DELETE** /scores/{score} | Delete a score\n*ScoreApi* | [**delete_score_comment**](docs/ScoreApi.md#delete_score_comment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment\n*ScoreApi* | [**delete_score_track**](docs/ScoreApi.md#delete_score_track) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score\n*ScoreApi* | [**edit_score**](docs/ScoreApi.md#edit_score) | **PUT** /scores/{score} | Edit a score\u0026#39;s metadata\n*ScoreApi* | [**fork_score**](docs/ScoreApi.md#fork_score) | **POST** /scores/{score}/fork | Fork a score\n*ScoreApi* | [**ger_user_likes**](docs/ScoreApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores\n*ScoreApi* | [**get_group_scores**](docs/ScoreApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group\u0026#39;s scores\n*ScoreApi* | [**get_score**](docs/ScoreApi.md#get_score) | **GET** /scores/{score} | Get a score\u0026#39;s metadata\n*ScoreApi* | [**get_score_collaborator**](docs/ScoreApi.md#get_score_collaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator\n*ScoreApi* | [**get_score_collaborators**](docs/ScoreApi.md#get_score_collaborators) | **GET** /scores/{score}/collaborators | List the collaborators\n*ScoreApi* | [**get_score_comments**](docs/ScoreApi.md#get_score_comments) | **GET** /scores/{score}/comments | List comments\n*ScoreApi* | [**get_score_revision**](docs/ScoreApi.md#get_score_revision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision\n*ScoreApi* | [**get_score_revision_data**](docs/ScoreApi.md#get_score_revision_data) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data\n*ScoreApi* | [**get_score_revisions**](docs/ScoreApi.md#get_score_revisions) | **GET** /scores/{score}/revisions | List the revisions\n*ScoreApi* | [**get_score_submissions**](docs/ScoreApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score\n*ScoreApi* | [**get_score_track**](docs/ScoreApi.md#get_score_track) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score\n*ScoreApi* | [**get_user_scores**](docs/ScoreApi.md#get_user_scores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n*ScoreApi* | [**list_score_tracks**](docs/ScoreApi.md#list_score_tracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score\n*ScoreApi* | [**mark_score_comment_resolved**](docs/ScoreApi.md#mark_score_comment_resolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved\n*ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved\n*ScoreApi* | [**post_score_comment**](docs/ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment\n*ScoreApi* | [**remove_score_collaborator**](docs/ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator\n*ScoreApi* | [**untrash_score**](docs/ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score\n*ScoreApi* | [**update_score_comment**](docs/ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment\n*ScoreApi* | [**update_score_track**](docs/ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score\n*TaskApi* | [**get_task**](docs/TaskApi.md#get_task) | **GET** /tasks/{task} | Get a task details\n*UserApi* | [**ger_user_likes**](docs/UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores\n*UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile\n*UserApi* | [**get_user_scores**](docs/UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user\u0026#39;s scores\n\n\n## Documentation For Models\n\n - [ApiAccessToken](docs/ApiAccessToken.md)\n - [AppScopes](docs/AppScopes.md)\n - [Assignment](docs/Assignment.md)\n - [AssignmentCopy](docs/AssignmentCopy.md)\n - [AssignmentCopyResponse](docs/AssignmentCopyResponse.md)\n - [AssignmentCopyResponseCapabilities](docs/AssignmentCopyResponseCapabilities.md)\n - [AssignmentCopyResponseCapabilitiesCanPublishInClassError](docs/AssignmentCopyResponseCapabilitiesCanPublishInClassError.md)\n - [AssignmentSubmission](docs/AssignmentSubmission.md)\n - [AssignmentSubmissionComment](docs/AssignmentSubmissionComment.md)\n - [AssignmentSubmissionCommentCreation](docs/AssignmentSubmissionCommentCreation.md)\n - [AssignmentSubmissionHistory](docs/AssignmentSubmissionHistory.md)\n - [AssignmentSubmissionHistoryAttachment](docs/AssignmentSubmissionHistoryAttachment.md)\n - [AssignmentSubmissionHistoryState](docs/AssignmentSubmissionHistoryState.md)\n - [AssignmentSubmissionState](docs/AssignmentSubmissionState.md)\n - [AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)\n - [AssignmentSubmissionUpdateComments](docs/AssignmentSubmissionUpdateComments.md)\n - [AssignmentType](docs/AssignmentType.md)\n - [AssignmentUpdate](docs/AssignmentUpdate.md)\n - [ClassAssignment](docs/ClassAssignment.md)\n - [ClassAssignmentCanvas](docs/ClassAssignmentCanvas.md)\n - [ClassAssignmentLti](docs/ClassAssignmentLti.md)\n - [ClassAssignmentMfc](docs/ClassAssignmentMfc.md)\n - [ClassAssignmentUpdate](docs/ClassAssignmentUpdate.md)\n - [ClassAssignmentUpdateGoogleClassroom](docs/ClassAssignmentUpdateGoogleClassroom.md)\n - [ClassAssignmentUpdateMicrosoftGraph](docs/ClassAssignmentUpdateMicrosoftGraph.md)\n - [ClassAttachmentCreation](docs/ClassAttachmentCreation.md)\n - [ClassCreation](docs/ClassCreation.md)\n - [ClassDetails](docs/ClassDetails.md)\n - [ClassDetailsCanvas](docs/ClassDetailsCanvas.md)\n - [ClassDetailsClever](docs/ClassDetailsClever.md)\n - [ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)\n - [ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)\n - [ClassDetailsIssues](docs/ClassDetailsIssues.md)\n - [ClassDetailsIssuesSyncInner](docs/ClassDetailsIssuesSyncInner.md)\n - [ClassDetailsLti](docs/ClassDetailsLti.md)\n - [ClassDetailsMfc](docs/ClassDetailsMfc.md)\n - [ClassDetailsMicrosoftGraph](docs/ClassDetailsMicrosoftGraph.md)\n - [ClassGradeLevel](docs/ClassGradeLevel.md)\n - [ClassRoles](docs/ClassRoles.md)\n - [ClassState](docs/ClassState.md)\n - [ClassUpdate](docs/ClassUpdate.md)\n - [Collection](docs/Collection.md)\n - [CollectionApp](docs/CollectionApp.md)\n - [CollectionCapabilities](docs/CollectionCapabilities.md)\n - [CollectionCreation](docs/CollectionCreation.md)\n - [CollectionModification](docs/CollectionModification.md)\n - [CollectionPrivacy](docs/CollectionPrivacy.md)\n - [CollectionType](docs/CollectionType.md)\n - [EduLibrary](docs/EduLibrary.md)\n - [EduResource](docs/EduResource.md)\n - [EduResourceCapabilities](docs/EduResourceCapabilities.md)\n - [EduResourceCopy](docs/EduResourceCopy.md)\n - [EduResourceCreation](docs/EduResourceCreation.md)\n - [EduResourceMove](docs/EduResourceMove.md)\n - [EduResourcePrivacy](docs/EduResourcePrivacy.md)\n - [EduResourceResource](docs/EduResourceResource.md)\n - [EduResourceType](docs/EduResourceType.md)\n - [EduResourceUpdate](docs/EduResourceUpdate.md)\n - [EduResourceUseInClass](docs/EduResourceUseInClass.md)\n - [EduSkillsFocused](docs/EduSkillsFocused.md)\n - [FlatErrorResponse](docs/FlatErrorResponse.md)\n - [FlatLocales](docs/FlatLocales.md)\n - [GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md)\n - [GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)\n - [Group](docs/Group.md)\n - [GroupDetails](docs/GroupDetails.md)\n - [GroupType](docs/GroupType.md)\n - [LicenseMode](docs/LicenseMode.md)\n - [LicenseSources](docs/LicenseSources.md)\n - [LmsName](docs/LmsName.md)\n - [LtiCredentials](docs/LtiCredentials.md)\n - [LtiCredentialsCreation](docs/LtiCredentialsCreation.md)\n - [MediaAttachment](docs/MediaAttachment.md)\n - [MediaScoreSharingMode](docs/MediaScoreSharingMode.md)\n - [MicrosoftGraphAssignment](docs/MicrosoftGraphAssignment.md)\n - [MicrosoftGraphSubmission](docs/MicrosoftGraphSubmission.md)\n - [OrganizationInvitation](docs/OrganizationInvitation.md)\n - [OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)\n - [OrganizationRoles](docs/OrganizationRoles.md)\n - [OrganizationUserAccessTokenCreation](docs/OrganizationUserAccessTokenCreation.md)\n - [ResourceCollaborator](docs/ResourceCollaborator.md)\n - [ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md)\n - [ResourceRights](docs/ResourceRights.md)\n - [ScoreComment](docs/ScoreComment.md)\n - [ScoreCommentContext](docs/ScoreCommentContext.md)\n - [ScoreCommentCreation](docs/ScoreCommentCreation.md)\n - [ScoreCommentModeration](docs/ScoreCommentModeration.md)\n - [ScoreCommentUpdate](docs/ScoreCommentUpdate.md)\n - [ScoreCommentsCounts](docs/ScoreCommentsCounts.md)\n - [ScoreCreation](docs/ScoreCreation.md)\n - [ScoreCreationBuilderData](docs/ScoreCreationBuilderData.md)\n - [ScoreCreationBuilderDataLayoutData](docs/ScoreCreationBuilderDataLayoutData.md)\n - [ScoreCreationBuilderDataScoreData](docs/ScoreCreationBuilderDataScoreData.md)\n - [ScoreCreationBuilderDataScoreDataInstrumentsInner](docs/ScoreCreationBuilderDataScoreDataInstrumentsInner.md)\n - [ScoreCreationType](docs/ScoreCreationType.md)\n - [ScoreDetails](docs/ScoreDetails.md)\n - [ScoreFork](docs/ScoreFork.md)\n - [ScoreLicense](docs/ScoreLicense.md)\n - [ScoreLikesCounts](docs/ScoreLikesCounts.md)\n - [ScoreModification](docs/ScoreModification.md)\n - [ScorePlaysCounts](docs/ScorePlaysCounts.md)\n - [ScorePrivacy](docs/ScorePrivacy.md)\n - [ScoreRevision](docs/ScoreRevision.md)\n - [ScoreRevisionCreation](docs/ScoreRevisionCreation.md)\n - [ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)\n - [ScoreSource](docs/ScoreSource.md)\n - [ScoreTrack](docs/ScoreTrack.md)\n - [ScoreTrackCreation](docs/ScoreTrackCreation.md)\n - [ScoreTrackPoint](docs/ScoreTrackPoint.md)\n - [ScoreTrackState](docs/ScoreTrackState.md)\n - [ScoreTrackType](docs/ScoreTrackType.md)\n - [ScoreTrackUpdate](docs/ScoreTrackUpdate.md)\n - [ScoreViewsCounts](docs/ScoreViewsCounts.md)\n - [Task](docs/Task.md)\n - [TaskExportOptions](docs/TaskExportOptions.md)\n - [TaskProgress](docs/TaskProgress.md)\n - [TaskResult](docs/TaskResult.md)\n - [UserAdminUpdate](docs/UserAdminUpdate.md)\n - [UserAzureDetails](docs/UserAzureDetails.md)\n - [UserCommunityProfileLinks](docs/UserCommunityProfileLinks.md)\n - [UserCreation](docs/UserCreation.md)\n - [UserDetails](docs/UserDetails.md)\n - [UserDetailsAdmin](docs/UserDetailsAdmin.md)\n - [UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md)\n - [UserPublic](docs/UserPublic.md)\n - [UserPublicSummary](docs/UserPublicSummary.md)\n - [UserSigninLink](docs/UserSigninLink.md)\n - [UserSigninLinkCreation](docs/UserSigninLinkCreation.md)\n\n\n## Documentation For Authorization\n\n\n## OAuth2\n\n- **Type**: OAuth\n- **Flow**: accessCode\n- **Authorization URL**: https://flat.io/auth/oauth\n- **Scopes**: \n - **account.public_profile**: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile. \n - **account.email**: Provices access to the person's email. \n - **account.education_profile**: Provides access to the basic person's education profile and public organization information. \n - **scores.readonly**: Allows read-only access to all a user's scores. You won't need this scope to read public scores. \n - **scores.social**: Allow to post comments and like scores \n - **scores**: Full, permissive scope to access all of a user's scores. \n - **collections.readonly**: Allow read-only access to a user's collections.\n - **collections.add_scores**: Allow to add scores to a user's collections.\n - **collections**: Full, permissive scope to access all of a user's collections.\n - **edu.resources**: Read-write access to the resource library.\n - **edu.resources.readonly**: Read-only access to the resource library.\n - **edu.classes**: Full, permissive scope to manage the classes.\n - **edu.classes.readonly**: Read-only access to the classes.\n - **edu.assignments**: Read-write access to the assignments and submissions.\n - **edu.assignments.readonly**: Read-only access to the assignments and submissions.\n - **edu.admin**: Full, permissive scope to manage all the admin of an organization.\n - **edu.admin.lti**: Access and manage the LTI Credentials for an organization.\n - **edu.admin.lti.readonly**: Read-only access to the LTI Credentials of an organization.\n - **edu.admin.users**: Access and manage the users and invitations of the organization.\n - **edu.admin.users.readonly**: Read-only access to the users and invitations of the organization.\n - **tasks.readonly**: Read-only access to export tasks created by this account.\n\n\n## Author\n\ndevelopers@flat.io\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in flat_api.apis and flat_api.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from flat_api.api.default_api import DefaultApi`\n- `from flat_api.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport flat_api\nfrom flat_api.apis import *\nfrom flat_api.models import *\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflatio%2Fapi-client-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflatio%2Fapi-client-python/lists"}