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 can install it using:
pip install flareio-cli
However, we recommend that you invoke it using uv. Example:
uvx flareio-cli --help
Configuration
For most commands, the cli requires that you export the FLARE_API_KEY environment variable.
Usage Examples
Export Tenant Feed to jsonl file
$ export FLARE_API_KEY="<api-key>"
$ uvx run flareio-cli export-tenant-feed --cursor-file=cursor.txt --output-file=output.txt --from-date=2025-01-01
Contributing
We recommend the following dependencies:
makeuvdirenv
The Makefile contains the following targets:
make testwill run testsmake checkwill run typecheckingmake formatformat will format the codemake format-checkwill run lintingmake ciwill run CI equivalent
Feedback
Do you have ideas or feature requests? Feel free to open issues.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flareio_cli-0.4.2.tar.gz.
File metadata
- Download URL: flareio_cli-0.4.2.tar.gz
- Upload date:
- Size: 4.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
94525d21249fa55a302a1ccf80d7397ea57cde25c22d18cc21c759fafb6412cc
|
|
| MD5 |
79ac9f48a2ccb7adc8aa588c7d989a3a
|
|
| BLAKE2b-256 |
b8ed61e219aaf688548bd6fb58cecb83dfe63869f46ff0f99b697ca0d585678e
|
File details
Details for the file flareio_cli-0.4.2-py3-none-any.whl.
File metadata
- Download URL: flareio_cli-0.4.2-py3-none-any.whl
- Upload date:
- Size: 9.6 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b9689ce3f197b9e43b1cb3971e71fef8c324de06555b2b24ef750268528cf0dd
|
|
| MD5 |
544427a28884e2a7539503cdaf9fdba1
|
|
| BLAKE2b-256 |
fef7edc1e2dd29e7fb38b2d42a012e8e3f5a5603e996a9c4ba687e50d067eb58
|
