Skip to main content

Python Client for the Flat REST API

Build Status

The Flat API allows you to easily extend the abilities of the Flat Platform, 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 project.

Requirements.

Python 2.7 to 3.5+

Installation & Usage

pip install

pip install flat_api
pip install git+https://github.com/FlatIO/api-client-python.git

Then import the package:

import flat_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flat_api

Getting Started

Please follow the installation procedure above and then run the following:

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)

Metadata

Release files for flat-api 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flat-api 0.4.0
File Size Uploaded Provenance
flat_api-0.4.0.tar.gz 84.1 kB Without provenance Details

Release files / flat_api-0.4.0.tar.gz

Download URL flat_api-0.4.0.tar.gz
Size 84.1 kB
Tags Source
SHA-256 checksum
How to use checksums
44b46efe21ce7d3807f60a8a562977516f313c0cc6baaba292899ac985365103
BLAKE2b-256 checksum
How to use checksums
5d04db7ad290ac2d87cff42fe6b55ff8049b4ca81932a4b058534c6258d61d76
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for flat-api 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page