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.0.3b0.tar.gz (286.4 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.0.3b0-py3-none-any.whl (400.0 kB view details)

Uploaded Python 3

File details

Details for the file domolibrary2-2.0.3b0.tar.gz.

File metadata

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

File hashes

Hashes for domolibrary2-2.0.3b0.tar.gz
Algorithm Hash digest
SHA256 c8003487c3ba9c817d586ef574708501b38f1416cee52b407798b9644c9c24cf
MD5 35a253aff78ec1cc5f4567872d07c208
BLAKE2b-256 14bd07419ee01b2b5d084d820637d79620c8899bce5c51b7f424d6399539d72b

See more details on using hashes here.

File details

Details for the file domolibrary2-2.0.3b0-py3-none-any.whl.

File metadata

  • Download URL: domolibrary2-2.0.3b0-py3-none-any.whl
  • Upload date:
  • Size: 400.0 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.0.3b0-py3-none-any.whl
Algorithm Hash digest
SHA256 cfe629a1ab4b6ecc65d6a063686ef9e4e5984451c656a3e5636a78593e8998a3
MD5 fb6ed520677327249a0f89a5137bcfe9
BLAKE2b-256 7901a5cf375fa15bbf71690bdda28f773ebc0a5e6434acee644a23ce12295291

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