Skip to main content

CLI interface for the flare.io API

Project description

flareio-cli

flareio-cli is a beta CLI interface for the flare.io API.

The full CLI documentation can be found on Flare's API documentation website.

Installing

flareio-cli is available on PyPI. You may find all available versions on the Github releases page.

Invoke it directly using uv (recommended):

# Running the most recent version.
uvx flareio-cli --help

# Running a specific version. Recommended to ensure stability.
# Example: uvx flareio-cli@0.5.0 --help
uvx flareio-cli@version --help

Or install it:

# Using uv
uv tool install flareio-cli

# Using pip
pip install flareio-cli

Usage Example

Export Tenant Feed to CSV file:

export FLARE_API_KEY="<api-key>"

uvx run flareio-cli export-tenant-feed \
    --cursor-file=cursor.txt \
    --output-file=output.csv \
    --from-date=2025-01-01

Learn more in the full CLI documentation.

Contributing

We recommend the following dependencies:

  • make
  • uv
  • direnv

The Makefile contains the following targets:

  • make test will run tests
  • make check will run typechecking
  • make format format will format the code
  • make format-check will run linting
  • make ci will run CI equivalent

Feedback

Do you have ideas or feature requests? Feel free to open issues.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flareio_cli-0.5.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flareio_cli-0.5.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file flareio_cli-0.5.1.tar.gz.

File metadata

  • Download URL: flareio_cli-0.5.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flareio_cli-0.5.1.tar.gz
Algorithm Hash digest
SHA256 5cf3cc7835e988b15ecf143a12bf4b66779f44722bbc31d988e10804a8f672a0
MD5 942005bef306f23b6236b33c8af20701
BLAKE2b-256 94177451511b7e295ef2a86793ee6ecee1a217baa6ef8b2221c83810d72f02b8

See more details on using hashes here.

File details

Details for the file flareio_cli-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: flareio_cli-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flareio_cli-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9506f6f44eec69269bc13bf0d064bea946538123a54d7ad7b7ed16671cb17b9a
MD5 05e647683c270a74e4559fb48d73123c
BLAKE2b-256 c1d9996d8a127e62dd4af6bcf4c64133d3c6cb7836b39b3980469d7a9716c3a2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page