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

Uploaded Python 3

File details

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

File metadata

  • Download URL: flareio_cli-0.7.4.tar.gz
  • Upload date:
  • Size: 6.5 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.4.tar.gz
Algorithm Hash digest
SHA256 c4eb6048baba1c9156ac519181f4980c4960b997ae263d796a317b3e0c4813a0
MD5 315ff1f8d733d8ebcd7e296c340bbcfa
BLAKE2b-256 16b101db836f763916fd48f995cb5610b8af08e538d9d904fbf01f652ed5204a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flareio_cli-0.7.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0e5aab5957e3aa11b39ed87f81c1d80ea297000bb28a518ba4e3cfc8b592528b
MD5 c4fd2b8e2bd978078b1fa1ece1a615db
BLAKE2b-256 ef012bee68a5808e546eb6632a168af6abed2017ea116282d95dc2a496c15bce

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