tickr-client 0.1.2

Python client for the Tickr API (counters service)

Tickr Python Client

Simple, Shareable, Powerful Counters for Anything.

A Python client library for interacting with the Tickr API (counters service).

---

Features

• Fetch all your counters (requires authentication)
• Create a new counter (requires authentication)
• Fetch a public counter by slug
• Increment a counter (public or private, depending on API config)
• Update a counter (requires authentication and ownership)
• Delete a counter (requires authentication and ownership)
• Supports API key authentication (recommended; JWT is deprecated)
• Supports is_private and is_readonly counter properties

Installation

pip install -e .

Usage

from tickr_client import TickrClient

# Create a client instance (API key is recommended for authenticated endpoints)
# You can get your API key from the Tickr API docs page: https://tickr.cc/api-docs
client = TickrClient(api_key="YOUR_API_KEY")

# Fetch all counters (authenticated)
counters = client.get_counters()

# Create a new counter (authenticated, with privacy/read-only options)
new_counter = client.create_counter(name="My Counter", initial_value=10, is_private=True, is_readonly=False)

# Fetch a public counter by slug
public_counter = client.get_counter(slug="abc123xyz")

# Increment a counter (public or private)
updated_counter = client.increment_counter(slug="abc123xyz", increment_by=2)

# Update a counter (authenticated, owner only)
updated = client.update_counter(slug="abc123xyz", name="Renamed", current_value=42, is_private=False)

# Delete a counter (authenticated, owner only)
client.delete_counter(slug="abc123xyz")

Authentication

For authenticated endpoints, obtain an API key from your Tickr dashboard and pass it to the client as api_key. Public endpoints do not require authentication.

Note: JWT authentication is deprecated. Use API keys for all new integrations.

Counter Properties

• is_private: If True, only authorized users can increment the counter.
• is_readonly: If True, the counter cannot be incremented by anyone.

These properties are always included in returned counter objects.

License

MIT