Skip to main content

Flatfile Python Library

pypi fern shield

Documentation

API reference documentation is available here.

Installation

Add this dependency to your project's build file:

pip install flatfile
# or
poetry add flatfile

Usage

from flatfile.client import FlatFile
import flatfile

flatfile_client = FlatFile(
  token="API_KEY"
)

environment = flatfile_client.environments.create(
  name = 'dev',
  is_prod = False,
  new_spaces_inherit = False,
  guest_authentication = [flatfile.GuestAuthenticationEnum.SHARED_LINK],
);

print(f"Created environment with id {environment.id}");

Async Client

from flatfile.client import AsyncFlatFile
import flatfile

import asyncio

flatfile_client = AsyncFlatFile(
  token="API_KEY"
)

async def create_environment() -> None:
    environment = flatfile_client.environments.create(
      name = 'dev',
      is_prod = False,
      new_spaces_inherit = False,
      guest_authentication = [flatfile.GuestAuthenticationEnum.SHARED_LINK],
    );
    print(f"Created environment with id {environment.id}");

asyncio.run(create_environment())

Timeouts

By default, the client is configured to have a timeout of 60 seconds. You can customize this value at client instantiation.

from flatfile.client import FlatFile
import flatfile

flatfile_client = FlatFile(
  token="API_KEY",
  timeout=30
)

Handling Exceptions

All exceptions thrown by the SDK will sublcass flatfile.ApiError.

from flatfile.core import ApiError
import flatfile

try:
  flatfile_client.environments.get(id="environment-id")
except flatfile.BadRequestError as e: 
  # handle bad request error
except APIError as e:  
  # handle any api related error

Error codes are as followed:

Status Code Error Type
400 BadRequestError
404 NotFoundError

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Metadata

Release files for flatfile 1.0.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 flatfile 1.0.0
File Size Uploaded Provenance Actions
flatfile-1.0.0.tar.gz 166.1 kB Without provenance Details for flatfile-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for flatfile 1.0.0
File Interpreter ABI Platform Actions
flatfile-1.0.0-py3-none-any.whl Python 3 none any Details for flatfile-1.0.0-py3-none-any.whl

Total release size: 566.0 kB

Release files / flatfile-1.0.0.tar.gz

Download URL flatfile-1.0.0.tar.gz
Size 166.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3cebf52032c84f16be18bd5e8ef835aff4681cb7f682e5bb704ceb4ec27ab681
BLAKE2b-256 checksum
How to use checksums
038d4ea54fc1c11124efaabfd3bff4ed844102bdfd2709709187363148073198
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1078-azure

Release files / flatfile-1.0.0-py3-none-any.whl

Download URL flatfile-1.0.0-py3-none-any.whl
Size 399.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
45d95aa42af0c1b2e43f939ebb629bc4306024a4a3dbb0519c8ecf959f54dd63
BLAKE2b-256 checksum
How to use checksums
66c91376270a3b2589e27aef07f6bd05de198065982f94c3cc7a56240208d2b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1078-azure

Security for flatfile 1.0.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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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