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.7.1.tar.gz (6.1 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.1-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flareio_cli-0.7.1.tar.gz
  • Upload date:
  • Size: 6.1 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.7.1.tar.gz
Algorithm Hash digest
SHA256 c6d64746911f76b8528b43a9c34bd3bdc6b6a065b0b578367ebd76284bec2fc7
MD5 f7981eb550b0f3bf9ab5b42797361660
BLAKE2b-256 6dd7a48cc159a3e9efb2e8a5ccc37121a5a9c3a38704e64968749a3e7edeaf8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flareio_cli-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 13.1 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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f47bbcf9c97583f8cd5f7e33515e5274af2fea9c9b68bf4e0e5d098ab7e3ff9
MD5 26b17eadba5dbe46d2ce04d1122cbeb1
BLAKE2b-256 c87cd65837d02c3e87669e1dc4da05ab1fd5500983583467f9edd6fb5852add5

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