Metadata-Version: 1.0
Name: flat_api
Version: 0.1.0
Summary: Flat API Client
Home-page: https://github.com/FlatIO/api-client-python
Author: UNKNOWN
Author-email: developers@flat.io
License: UNKNOWN
Description: Python Client for the Flat REST API
        ===================================
        
        |Build Status|
        
        The 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: - Creating and importing new music scores using MusicXML
        or MIDI files - Browsing, updating, copying, exporting the user's scores
        (for example in MP3, WAV or MIDI) - Managing educational resources with
        Flat for Education: creating & updating the organization accounts, the
        classes, rosters and assignments.
        
        You can find the API reference including code samples and our OpenAPI
        Specification at the following url:
        https://flat.io/developers/api/reference.
        
        To request some API credentials, please visit
        https://flat.io/developers.
        
        This Python package is automatically generated by the `Swagger
        Codegen <https://github.com/swagger-api/swagger-codegen>`__ project.
        
        Requirements.
        -------------
        
        Python 2.7 to 3.4+
        
        Installation & Usage
        --------------------
        
        pip install
        ~~~~~~~~~~~
        
        .. code:: sh
        
            pip install flat_api
        
        .. code:: sh
        
            pip install git+https://github.com/FlatIO/api-client-python.git
        
        Then import the package:
        
        .. code:: python
        
            import flat_api
        
        Setuptools
        ~~~~~~~~~~
        
        Install via `Setuptools <http://pypi.python.org/pypi/setuptools>`__.
        
        .. code:: sh
        
            python setup.py install --user
        
        (or ``sudo python setup.py install`` to install the package for all
        users)
        
        Then import the package:
        
        .. code:: python
        
            import flat_api
        
        Getting Started
        ---------------
        
        Please follow the `installation procedure <#installation--usage>`__ and
        then run the following:
        
        .. code:: python
        
            from __future__ import print_function
            import time
            import flat_api
            from flat_api.rest import ApiException
            from pprint import pprint
        
            # Configure OAuth2 access token for authorization: OAuth2
            flat_api.configuration.access_token = 'YOUR_ACCESS_TOKEN'
            # create an instance of the API class
            api_instance = flat_api.AccountApi()
        
            try:
                # Get current user profile
                api_response = api_instance.get_authenticated_user()
                pprint(api_response)
            except ApiException as e:
                print("Exception when calling AccountApi->get_authenticated_user: %s\n" % e)
        
        Documentation for API Endpoints
        -------------------------------
        
        All URIs are relative to *https://api.flat.io/v2*
        
        +---------------+----------------+----------------+----------------+
        | Class         | Method         | HTTP request   | Description    |
        +===============+================+================+================+
        | *AccountApi*  | `**get\_authen | **GET** /me    | Get current    |
        |               | ticated\_user* |                | user profile   |
        |               | * <docs/Accoun |                |                |
        |               | tApi.md#get_au |                |                |
        |               | thenticated_us |                |                |
        |               | er>`__         |                |                |
        +---------------+----------------+----------------+----------------+
        | *GroupApi*    | `**get\_group\ | **GET**        | List group's   |
        |               | _scores** <doc | /groups/{group | scores         |
        |               | s/GroupApi.md# | }/scores       |                |
        |               | get_group_scor |                |                |
        |               | es>`__         |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**add\_score\ | **POST**       | Add a new      |
        |               | _collaborator* | /scores/{score | collaborator   |
        |               | * <docs/ScoreA | }/collaborator |                |
        |               | pi.md#add_scor | s              |                |
        |               | e_collaborator |                |                |
        |               | >`__           |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**create\_sco | **POST**       | Create a new   |
        |               | re** <docs/Sco | /scores        | score          |
        |               | reApi.md#creat |                |                |
        |               | e_score>`__    |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**create\_sco | **POST**       | Create a new   |
        |               | re\_revision** | /scores/{score | revision       |
        |               |  <docs/ScoreAp | }/revisions    |                |
        |               | i.md#create_sc |                |                |
        |               | ore_revision>` |                |                |
        |               | __             |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**delete\_sco | **DELETE**     | Delete a score |
        |               | re** <docs/Sco | /scores/{score |                |
        |               | reApi.md#delet | }              |                |
        |               | e_score>`__    |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**delete\_sco | **DELETE**     | Delete a       |
        |               | re\_comment**  | /scores/{score | comment        |
        |               | <docs/ScoreApi | }/comments/{co |                |
        |               | .md#delete_sco | mment}         |                |
        |               | re_comment>`__ |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**edit\_score | **PUT**        | Edit a score's |
        |               | ** <docs/Score | /scores/{score | metadata       |
        |               | Api.md#edit_sc | }              |                |
        |               | ore>`__        |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**fork\_score | **POST**       | Fork a score   |
        |               | ** <docs/Score | /scores/{score |                |
        |               | Api.md#fork_sc | }/fork         |                |
        |               | ore>`__        |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**ger\_user\_ | **GET**        | List liked     |
        |               | likes** <docs/ | /users/{user}/ | scores         |
        |               | ScoreApi.md#ge | likes          |                |
        |               | r_user_likes>` |                |                |
        |               | __             |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_group\ | **GET**        | List group's   |
        |               | _scores** <doc | /groups/{group | scores         |
        |               | s/ScoreApi.md# | }/scores       |                |
        |               | get_group_scor |                |                |
        |               | es>`__         |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score* | **GET**        | Get a score's  |
        |               | * <docs/ScoreA | /scores/{score | metadata       |
        |               | pi.md#get_scor | }              |                |
        |               | e>`__          |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | Get a          |
        |               | _collaborator* | /scores/{score | collaborator   |
        |               | * <docs/ScoreA | }/collaborator |                |
        |               | pi.md#get_scor | s/{collaborato |                |
        |               | e_collaborator | r}             |                |
        |               | >`__           |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | List the       |
        |               | _collaborators | /scores/{score | collaborators  |
        |               | ** <docs/Score | }/collaborator |                |
        |               | Api.md#get_sco | s              |                |
        |               | re_collaborato |                |                |
        |               | rs>`__         |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | List comments  |
        |               | _comments** <d | /scores/{score |                |
        |               | ocs/ScoreApi.m | }/comments     |                |
        |               | d#get_score_co |                |                |
        |               | mments>`__     |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | Get a score    |
        |               | _revision** <d | /scores/{score | revision       |
        |               | ocs/ScoreApi.m | }/revisions/{r |                |
        |               | d#get_score_re | evision}       |                |
        |               | vision>`__     |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | Get a score    |
        |               | _revision\_dat | /scores/{score | revision data  |
        |               | a** <docs/Scor | }/revisions/{r |                |
        |               | eApi.md#get_sc | evision}/{form |                |
        |               | ore_revision_d | at}            |                |
        |               | ata>`__        |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_score\ | **GET**        | List the       |
        |               | _revisions** < | /scores/{score | revisions      |
        |               | docs/ScoreApi. | }/revisions    |                |
        |               | md#get_score_r |                |                |
        |               | evisions>`__   |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**get\_user\_ | **GET**        | List user's    |
        |               | scores** <docs | /users/{user}/ | scores         |
        |               | /ScoreApi.md#g | scores         |                |
        |               | et_user_scores |                |                |
        |               | >`__           |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**mark\_score | **PUT**        | Mark the       |
        |               | \_comment\_res | /scores/{score | comment as     |
        |               | olved** <docs/ | }/comments/{co | resolved       |
        |               | ScoreApi.md#ma | mment}/resolve |                |
        |               | rk_score_comme | d              |                |
        |               | nt_resolved>`_ |                |                |
        |               | _              |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**mark\_score | **DELETE**     | Mark the       |
        |               | \_comment\_unr | /scores/{score | comment as     |
        |               | esolved** <doc | }/comments/{co | unresolved     |
        |               | s/ScoreApi.md# | mment}/resolve |                |
        |               | mark_score_com | d              |                |
        |               | ment_unresolve |                |                |
        |               | d>`__          |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**post\_score | **POST**       | Post a new     |
        |               | \_comment** <d | /scores/{score | comment        |
        |               | ocs/ScoreApi.m | }/comments     |                |
        |               | d#post_score_c |                |                |
        |               | omment>`__     |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**remove\_sco | **DELETE**     | Delete a       |
        |               | re\_collaborat | /scores/{score | collaborator   |
        |               | or** <docs/Sco | }/collaborator |                |
        |               | reApi.md#remov | s/{collaborato |                |
        |               | e_score_collab | r}             |                |
        |               | orator>`__     |                |                |
        +---------------+----------------+----------------+----------------+
        | *ScoreApi*    | `**update\_sco | **PUT**        | Update an      |
        |               | re\_comment**  | /scores/{score | existing       |
        |               | <docs/ScoreApi | }/comments/{co | comment        |
        |               | .md#update_sco | mment}         |                |
        |               | re_comment>`__ |                |                |
        +---------------+----------------+----------------+----------------+
        | *UserApi*     | `**ger\_user\_ | **GET**        | List liked     |
        |               | likes** <docs/ | /users/{user}/ | scores         |
        |               | UserApi.md#ger | likes          |                |
        |               | _user_likes>`_ |                |                |
        |               | _              |                |                |
        +---------------+----------------+----------------+----------------+
        | *UserApi*     | `**get\_user** | **GET**        | Get a public   |
        |               |  <docs/UserApi | /users/{user}  | user profile   |
        |               | .md#get_user>` |                |                |
        |               | __             |                |                |
        +---------------+----------------+----------------+----------------+
        | *UserApi*     | `**get\_user\_ | **GET**        | List user's    |
        |               | scores** <docs | /users/{user}/ | scores         |
        |               | /UserApi.md#ge | scores         |                |
        |               | t_user_scores> |                |                |
        |               | `__            |                |                |
        +---------------+----------------+----------------+----------------+
        
        Documentation For Models
        ------------------------
        
        -  `ClassRoles <docs/ClassRoles.md>`__
        -  `FlatErrorResponse <docs/FlatErrorResponse.md>`__
        -  `FlatLocales <docs/FlatLocales.md>`__
        -  `Group <docs/Group.md>`__
        -  `OrganizationRoles <docs/OrganizationRoles.md>`__
        -  `ScoreCollaborator <docs/ScoreCollaborator.md>`__
        -  `ScoreCollaboratorCreation <docs/ScoreCollaboratorCreation.md>`__
        -  `ScoreComment <docs/ScoreComment.md>`__
        -  `ScoreCommentContext <docs/ScoreCommentContext.md>`__
        -  `ScoreCommentCreation <docs/ScoreCommentCreation.md>`__
        -  `ScoreCommentUpdate <docs/ScoreCommentUpdate.md>`__
        -  `ScoreCommentsCounts <docs/ScoreCommentsCounts.md>`__
        -  `ScoreCreation <docs/ScoreCreation.md>`__
        -  `ScoreData <docs/ScoreData.md>`__
        -  `ScoreDataEncoding <docs/ScoreDataEncoding.md>`__
        -  `ScoreDetails <docs/ScoreDetails.md>`__
        -  `ScoreFork <docs/ScoreFork.md>`__
        -  `ScoreLikesCounts <docs/ScoreLikesCounts.md>`__
        -  `ScoreModification <docs/ScoreModification.md>`__
        -  `ScorePrivacy <docs/ScorePrivacy.md>`__
        -  `ScoreRevision <docs/ScoreRevision.md>`__
        -  `ScoreRevisionCreation <docs/ScoreRevisionCreation.md>`__
        -  `ScoreRevisionStatistics <docs/ScoreRevisionStatistics.md>`__
        -  `ScoreRights <docs/ScoreRights.md>`__
        -  `ScoreSource <docs/ScoreSource.md>`__
        -  `ScoreSummary <docs/ScoreSummary.md>`__
        -  `ScoreViewsCounts <docs/ScoreViewsCounts.md>`__
        -  `UserBasics <docs/UserBasics.md>`__
        -  `UserDetails <docs/UserDetails.md>`__
        -  `UserPublic <docs/UserPublic.md>`__
        -  `UserPublicSummary <docs/UserPublicSummary.md>`__
        
        OAuth2
        ------
        
        -  **Type**: OAuth
        -  **Flow**: accessCode
        -  **Authorization URL**: https://flat.io/auth/oauth
        -  **Scopes**:
        -  **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.
        -  **account.education\_profile**: Provides access to the basic person's
           education profile and public organization information.
        -  **scores.readonly**: Allows read-only access to all a user's scores.
           You won't need this scope to read public scores.
        -  **scores.social**: Allow to post comments and like scores
        -  **scores**: Full, permissive scope to access all of a user's scores.
        
        Author
        ------
        
        Flat - developers@flat.io
        
        .. |Build Status| image:: https://travis-ci.org/FlatIO/api-client-python.svg?branch=master
           :target: https://travis-ci.org/FlatIO/api-client-python
        
Keywords: Flat API,MusicXML,Music Notation,MIDI
Platform: UNKNOWN
