Skip to main content

A Python library for interacting with Domo APIs

Project description

Domolibrary

A Python library for interacting with Domo APIs.

Installation

pip install domolibrary

Usage

from domolibrary import DomoUser
# Your code here

Project Structure

src/                      # Main package source code
├── classes/              # Domain model classes
├── client/               # API client utilities
├── integrations/         # Integration modules
├── routes/               # API route implementations
├── utils/                # Utility functions
├── __init__.py           # Package initialization
└── _modidx.py           # Module index
scripts/                  # Development scripts
tests/                    # Test files
.vscode/                  # VS Code configuration
.github/workflows/        # CI/CD workflows

Development

This project uses uv for dependency management and development.

Setup Development Environment

# Initial setup (run once)
.\scripts\setup-dev.ps1

This will:

  • Install all dependencies (including dev dependencies)
  • Set up pre-commit hooks for automatic code quality checks

Development Scripts

All development scripts are located in the scripts/ folder. See scripts/README.md for detailed documentation.

Quick reference:

  • .\scripts\setup-dev.ps1 - Setup development environment
  • .\scripts\format-code.ps1 - Manual code formatting (fallback)
  • .\scripts\lint.ps1 - Run linting and type checking
  • .\scripts\test.ps1 - Run tests with coverage
  • .\scripts\build.ps1 - Build the package
  • .\scripts\publish.ps1 - Publish to PyPI (with validation)

Manual Development Commands

If you prefer to run commands manually:

# Install dependencies
uv sync --dev

# Run linting
uv run ruff check src --fix
uv run black src
uv run isort src
uv run pylint src
uv run mypy src

# Run tests
uv run pytest tests/ --cov=src

# Build package
uv build

# Publish (after all checks pass)
uv publish

Pre-commit Hooks

This project uses pre-commit hooks to automatically check code quality before commits:

  • Ruff - Fast Python linter
  • Black - Code formatter
  • isort - Import sorter

Hooks are installed automatically by setup-dev.ps1. If they cause issues, you can use .\scripts\format-code.ps1 as a fallback.

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

domolibrary2-2.1.1.tar.gz (322.7 kB view details)

Uploaded Source

Built Distribution

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

domolibrary2-2.1.1-py3-none-any.whl (447.3 kB view details)

Uploaded Python 3

File details

Details for the file domolibrary2-2.1.1.tar.gz.

File metadata

  • Download URL: domolibrary2-2.1.1.tar.gz
  • Upload date:
  • Size: 322.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for domolibrary2-2.1.1.tar.gz
Algorithm Hash digest
SHA256 81733488af7d4c4fa86c3b8c2bd79ca89f49788256b12b3a789d88c67e412106
MD5 7469fcd8a3d25615ec80cb6747a27146
BLAKE2b-256 def653f9c5e60f7c97a459e4176527b9d6745bc693a1e77486f263e2bb352895

See more details on using hashes here.

File details

Details for the file domolibrary2-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: domolibrary2-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 447.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for domolibrary2-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6cc219a0a17fd4fd0c9dc655378d0192c7b316d77f2fd32b075a20cbe2a11474
MD5 24d45caf18bd894732f9c60eb79179da
BLAKE2b-256 76dbe609de90b943557f4f8400ee9bbf1a0a88bf0eb885fcabefbc89eb2a43fe

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