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.3.tar.gz (6.4 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.3-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flareio_cli-0.7.3.tar.gz
  • Upload date:
  • Size: 6.4 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.3.tar.gz
Algorithm Hash digest
SHA256 c284da27883ba8d2e11cd2eb54812242191a848fc52f52c52bf8213dccce5c1f
MD5 86d85c348e2137fd4f592fbed4939532
BLAKE2b-256 95da6f163605007d73d05a3a46bf55df245cbb69130334b6325710766e213f94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flareio_cli-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 14.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 19b4d404c2c02d01416a2c526e6c5f462788e0934fa13e6757507e35a67c9f0a
MD5 0bf0aa784d40e41da78940c69258d5ce
BLAKE2b-256 e1928309db835d6b9dbd9f590b536b5b77f9ed1a64178844f067d217fbfbfc08

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