A Python library for interacting with Domo APIs
Project description
Last updated: 2025-11-17
Domolibrary
A Python library for interacting with Domo APIs.
This project includes GitHub Copilot custom prompts for enhanced development workflows. See the Copilot Kit section below.
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.
GitHub Copilot Integration
This project includes a curated collection of GitHub Copilot custom prompts and MCP (Model Context Protocol) server configurations to enhance your development workflow.
🎨 Custom Prompts
Ready-to-use prompts for common development tasks:
| Prompt | Description | Usage |
|---|---|---|
| architecture-review | Focused architectural review with actionable feedback | /architecture-review |
| code-review | High-rigor, tech-agnostic code review | /code-review |
| pragmatic-code-review | Production-focused code review balancing rigor with constraints | /pragmatic-code-review |
| refactor | Intelligent refactoring with best practices | /refactor |
| optimize-performance | Identify and fix performance anti-patterns | /optimize-performance |
| document | Generate exceptional documentation with diagrams | /document |
| create-prompt | Meta-prompt to generate new custom prompts | /create-prompt |
🤖 MCP Server Configuration
Model Context Protocol (MCP) lets Copilot connect to external tool servers for enhanced capabilities:
- Sequential Thinking - Structured thinking process for complex tasks
- Memory - Remember context between conversations
- Context7 - Access to up-to-date framework documentation
- Shadcn UI - Shadcn UI component knowledge (if using React)
- Chrome DevTools - Browser debugging capabilities
Quick MCP Setup
-
Copy memory template:
cp .mcp/memory.json.dist .mcp/memory.json
⚠️ Never commit
.mcp/memory.json- add to.gitignore -
Configure servers: The
.vscode/mcp.jsonfile is already set up with recommended servers. Copilot will prompt for any required API keys on first use. -
Enable MCP in VS Code: Ensure GitHub Copilot Chat has MCP enabled in settings.
📚 Documentation
- Custom Prompts Guide - Comprehensive guide on using and creating prompts
- Testing Guide - How to verify your setup is working correctly
- Fork Sync Guide - Information about keeping copilot-kit files updated
Using Prompts
Invoke prompts in GitHub Copilot Chat using the slash command:
/code-review
/refactor
/document
With optional arguments:
/code-review focus=security
/pragmatic-code-review maintainability
/optimize-performance
See the Custom Prompts Guide for detailed usage instructions.
Contributing
See CONTRIBUTING.md for guidelines on contributing to this project, including information about custom prompts and code review standards.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file domolibrary2-2.3.0.tar.gz.
File metadata
- Download URL: domolibrary2-2.3.0.tar.gz
- Upload date:
- Size: 558.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5372f2504efec62c16793c952ba5ced362e74e9b4e1ecba608bcdb327533f845
|
|
| MD5 |
abe046745c70f517f748be195cc6b2e8
|
|
| BLAKE2b-256 |
23dafac7c27062c157e986da5c119db7c97ed771f90eb4ad26d8095dadf15e03
|
File details
Details for the file domolibrary2-2.3.0-py3-none-any.whl.
File metadata
- Download URL: domolibrary2-2.3.0-py3-none-any.whl
- Upload date:
- Size: 838.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
159c436c791f0d28682cb499ca6274b451429e328004b78e49006d9e158e3c73
|
|
| MD5 |
5f89f98b120c3dd7af52e9d5ca25a7fb
|
|
| BLAKE2b-256 |
f58f72aa28b7ff9cc8a9f7ec5b5ce5659342eee56a3c4cdb76c2febf20ec8ab7
|