Skip to main content

A Python package

Project description

dhruv 🐍

A foundational Python package for AI-assisted development, featuring an AI Developer Handbook and batteries-included templates.

PyPI version Python Wheel Build status Codecov Code style: black Ruff Maintenance


⚡ Quick Start

Prerequisites

  • Python 3.8+
  • pip

Installation

pip install .

Or for development:

pip install -e .

Run

Verify the installation immediately:

dhruv hello

Demo

Use the core logic in your own scripts:

from dhruv.main import hello

# Access the core functionality directly
print(hello())
# Output: "Hello from Dhruv!"

✨ Features

  • 🧠 AI Developer Handbook: A comprehensive set of standardized system prompts (src/dhruv/prompts/) to guide AI agents through Documentation, Roadmapping, Testing, and Refactoring.
  • 🚀 Modern CLI Foundation: Built with Typer and Rich for a robust, beautiful, and self-documenting command-line interface.
  • 📦 Batteries-Included Templates: Pre-configured templates for pytest, project settings, and more, located in src/dhruv/templates/.
  • 🏗️ Clean Architecture: Follows a strict src layout with modular design, ensuring scalability and maintainability.
  • 🎨 Visual Utilities: Includes banner generation and syntax highlighting themes for a polished user experience.

🛠️ Configuration

CLI Arguments

The dhruv CLI is the primary interface.

Command Argument Description
dhruv hello Prints a welcome message to verify installation.
dhruv --help Show the help message and exit.

Note: No environment variables are currently required for core operation.


🏗️ Architecture

Directory Tree

src/
└── dhruv/
    ├── prompts/    # 📘 AI Developer Handbook & System Prompts
    ├── templates/  # 🛠️ Configuration Templates (pytest, settings)
    ├── utils/      # 🔧 Utility modules (banners, themes)
    ├── cli.py      # 🚀 CLI entry point (Typer)
    └── main.py     # 🧠 Core logic

High-Level Flow

  1. Entry Point: dhruv command triggers src/dhruv/cli.py.
  2. Routing: typer routes commands (e.g., hello) to their respective functions.
  3. Core Logic: Commands invoke logic in src/dhruv/main.py or access resources in prompts/ and templates/.
  4. Utilities: src/dhruv/utils/ provides shared functionality like banner rendering and styling.

🐞 Troubleshooting

Issue Possible Cause Solution
command not found: dhruv PATH issue or not installed. Ensure pip install . was successful and your Python scripts folder is in your PATH.
ModuleNotFoundError Virtual environment mismatch. Activate the correct venv where dhruv was installed.

Debug Mode

If you encounter unexpected behavior, check your Python version and environment details:

python --version
pip show dhruv

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Dev Setup

  1. Clone the repository.
  2. Install package in editable mode: pip install -e .
  3. Install test dependencies: pip install pytest pytest-cov
  4. Run tests: pytest

🗺️ Roadmap

  • Initial Release & Core Structure
  • CLI Implementation (typer)
  • AI Developer Handbook (Prompts)
  • Interactive Init: dhruv init to scaffold new projects.
  • Prompt Management: CLI commands to list and display prompts.
  • Template Injection: Automate copying templates to project root.

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

dhruv-2.0.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

dhruv-2.0.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file dhruv-2.0.0.tar.gz.

File metadata

  • Download URL: dhruv-2.0.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dhruv-2.0.0.tar.gz
Algorithm Hash digest
SHA256 fc2cf6e7a90ea0763d94817ed17fcf3b528d3b22f735663e4ac5ee30723e9fe9
MD5 1f1a818673aa9c2982a8c5d2fdc5a0a5
BLAKE2b-256 277cc4ee2b9a32568d05032bc8023ccd463c218cfeb484c1680ccb142166a987

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhruv-2.0.0.tar.gz:

Publisher: publish.yml on dhruv13x/dhruv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dhruv-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: dhruv-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dhruv-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e4ceb1a5602f0858aab1390a208fd2c28dba6ece79108f1ba04b27c2c6bdcac
MD5 1370c7a72b557a628efe413ab5b1e280
BLAKE2b-256 2f9bcffdf00fd4a56b6fa331f1fcfad2265594fd3512b0c868ac5e3e628ecad2

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhruv-2.0.0-py3-none-any.whl:

Publisher: publish.yml on dhruv13x/dhruv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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