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 \
    --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.8.0.tar.gz (6.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.8.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flareio_cli-0.8.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.8.0.tar.gz
Algorithm Hash digest
SHA256 51a41996d9986c8d09ef2d33afaab28ff3deaaed73fbab1d51c703a6402b446d
MD5 833e4f80370c76d7214ed224699df9cc
BLAKE2b-256 9f921d0d40ca4a08a1369c473437f9fe26d3d0b02893a93a4bbc247250662767

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flareio_cli-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c187c4c7be6f5a715f94caba9baaa0e276f47e6bdaf29abe33ad14660cb4c210
MD5 d40cd050687ad536682268705f0139ba
BLAKE2b-256 63c37755c2bf857bbbe6ae5fac816b6e897fdea996380348ddc87e8a5bfeb5cc

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