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.

Changelog & Releases

You may find the changelog and all available versions on the Github releases page.

Installing

flareio-cli is available on PyPI.

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.7.5.tar.gz (6.6 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.7.5-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flareio_cli-0.7.5.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","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.7.5.tar.gz
Algorithm Hash digest
SHA256 474826c841cf6818e5270ae123d968f30588d9c8a068f1c59137f0e14da882d9
MD5 e7a7a248607f91786726c59bd31d82d0
BLAKE2b-256 2881dfb7801c392b50f2fa08779b188db807dbf9084ab6ad07523ffc2ecad7a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flareio_cli-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.1 {"installer":{"name":"uv","version":"0.10.1","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.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 566faba79181632328c7fb2588c07f11245566ecb7df697746dd55e9e7023a03
MD5 cd2493087b6dfe59357a54275b18d33c
BLAKE2b-256 57f1e1ae305e7c8a0bde3b5bf09accb94af1dad74463a34f1aa9a134779ce49c

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