Skip to main content

CLI for managing Acuity Scheduling appointments, clients, and availability

Project description

acuity-cli

Python CLI for managing Acuity Scheduling appointments, clients, and availability.

Installation

macOS users: Modern macOS requires a virtual environment (PEP 668).

# Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate

# Install CLI
pip install -e ".[dev]"

Linux/WSL users:

pip install -e ".[dev]"

All installation options:

  • Option A: Virtual environment (recommended for macOS) - shown above
  • Option B: System Install (Linux/WSL) - see QUICKSTART.md
  • Option C: pipx (Isolated System Install) - see QUICKSTART.md
  • Full guide: See INSTALL.md

Update

acuity update

For Homebrew-managed Python (PEP 668), use:

acuity update --pipx
# or
acuity update --venv ~/venvs/acuity

Released Versions (PyPI vs Git Tags)

PyPI may lag behind git tags. If acuity --version does not match the latest tag, install from the tag directly:

pip install -U "dc-acuity-cli @ git+https://github.com/DallasCrilleyMarTech/acuity-scheduling.git@v1.3.0#subdirectory=acuity-cli"
hash -r
acuity --version

If your shell still shows an older version, check the active binary and reinstall:

which acuity
pip uninstall -y dc-acuity-cli
pip install -U "dc-acuity-cli @ git+https://github.com/DallasCrilleyMarTech/acuity-scheduling.git@v1.3.0#subdirectory=acuity-cli"
hash -r
acuity --version

Usage

# Step 1: Get appointment types (ALWAYS FIRST)
acuity types list

# Step 2: Check availability
acuity availability dates --type 12345 --month 2026-02
acuity availability times --type 12345 --date 2026-02-15

# Step 3: Validate slot
acuity availability check --type 12345 --datetime "2026-02-15T14:00:00"

# Step 4: Book appointment
acuity appointments book --type 12345 --datetime "2026-02-15T14:00:00" \
  --first-name Jane --last-name Doe --email jane@example.com

Configuration

Set credentials via environment variables or config file:

export ACUITY_USER_ID="your-user-id"
export ACUITY_API_KEY="your-api-key"

Or create ~/.config/acuity/config.json:

{
  "user_id": "your-user-id",
  "api_key": "your-api-key",
  "default_timezone": "America/Chicago",
  "output": "json"
}

Development

# Type checking
mypy acuity_cli

# Linting & formatting
ruff check acuity_cli
ruff format acuity_cli

# Run tests
pytest

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

dc_acuity_cli-1.4.1.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

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

dc_acuity_cli-1.4.1-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file dc_acuity_cli-1.4.1.tar.gz.

File metadata

  • Download URL: dc_acuity_cli-1.4.1.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for dc_acuity_cli-1.4.1.tar.gz
Algorithm Hash digest
SHA256 3d176cf0ebe891399b6412cb92754398ce6542456dd7c2f8457d0d8d885d3095
MD5 7c55eedd97766efcd451fac1c05102ec
BLAKE2b-256 482f91d6360b007c04a7f1b1ac2ef7c978960231c788f785d7aa00a84346093e

See more details on using hashes here.

File details

Details for the file dc_acuity_cli-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: dc_acuity_cli-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 29.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for dc_acuity_cli-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d1df0a325b6c02ad0ef86ff4e6727dedf1e6459bd0b5a4f56d3aa614c753f52
MD5 459a885f156b60b8082e197a96b15df8
BLAKE2b-256 7e2673a47b747aa3f0aa1bef80987a799a00b26d8e6d70d964d1d6d36ff28e6b

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