Skip to main content

CLI and Python client for friends.fyi

Project description

ffyi

CLI and Python client for friends.fyi.

Install

uv tool install ffyi

Installed commands: ffyi and fyi (alias).

CLI usage

ffyi login --server https://friends.fyi --api-key fyi_xxx
ffyi whoami
ffyi send brother "hello"
ffyi send brother --type timezone.changed --payload '{"timezone":"Europe/London"}'
ffyi inbox
ffyi inbox read <message_id>
ffyi keys create chad-daemon
ffyi keys list
ffyi keys revoke <key_id>

Config is stored at ~/.fyi/config.toml.

Python usage

from fyi import FyiClient

client = FyiClient(api_key="fyi_xxx", base_url="https://friends.fyi")
client.send("brother", type="timezone.changed", payload={"timezone": "Europe/London"})
messages = client.inbox(limit=10)

Development

uv sync --extra dev
uv run pytest
uv build --clear

Publish

export UV_PUBLISH_TOKEN='pypi-...'
uv publish --check-url https://pypi.org/simple --publish-url https://upload.pypi.org/legacy/

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

ffyi-0.1.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ffyi-0.1.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file ffyi-0.1.0.tar.gz.

File metadata

  • Download URL: ffyi-0.1.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.7

File hashes

Hashes for ffyi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2edc14ffa01bee6bd7aedd968f4ea11e83373b78f9338aae755bebbd1c540996
MD5 51f0dc3058fcc2892b9dd0a972845a1e
BLAKE2b-256 2e2fc9ef46aaf84d713024bccd0e9daf1559e692702167edf8c167fb7ba5f86b

See more details on using hashes here.

File details

Details for the file ffyi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ffyi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.7

File hashes

Hashes for ffyi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2301245041e113916cb855c89bd6b4ed150a97667e624f07ccf7e86f08e5ecb8
MD5 d0f76b483d3ca329cb7ad982ba745b77
BLAKE2b-256 b36c33ae3c186a05e67121175987add38fd1d645868562983f5bdc9f03bbc611

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