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.2.tar.gz (29.1 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.2-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dc_acuity_cli-1.4.2.tar.gz
  • Upload date:
  • Size: 29.1 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.2.tar.gz
Algorithm Hash digest
SHA256 df59e3d2af2eda6b269b993d2e08df37b84c239a20a74df3624482381e29571a
MD5 1d41b4293a93325d92f07bf0331ba49b
BLAKE2b-256 d0471dd8470f5b83165d4f2b984246080934f1dd55d9d22e91b961be6f22a61b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dc_acuity_cli-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 29.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 87a984fe993c5793eabebc86c0862bea48fc931c5415594191a73ad08cb074d1
MD5 265113b6934212d01452956412587226
BLAKE2b-256 544988d8192bb376d1057a9fcd88db00ab09beb2c7d1f8dc6bb33ac1e43a665b

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