Skip to main content

A Python package

Project description

dhruv logo

PyPI version Python Wheel Release

Build status Codecov Test Coverage Code style: black Ruff Security

Downloads PyPI Downloads OS Python Versions

License: MIT

Docs

dhruv 🐍

A foundational Python package for AI-assisted development, designed for simplicity and extensibility.

About

Dhruv is more than just a template; it's a "batteries-included" foundation for building robust Python tools. It comes pre-packaged with an AI Developer Handbook—a set of system prompts used to standardize documentation, roadmapping, testing, and refactoring—along with ready-to-use configuration templates.


🚀 Quick Start

Prerequisites

  • Python 3.8 or higher

Installation

For a straightforward installation, run the following command in the root directory:

pip install .

For developers who wish to modify the source code, install it in editable mode:

pip install -e .

Usage Example

Verify the installation with the built-in CLI:

dhruv hello
# Expected Output: "Hello from Dhruv!"

✨ Key Features

  • AI Developer Handbook: Includes a comprehensive set of system prompts (src/dhruv/prompts/) to guide AI agents through Documentation, Roadmapping, Testing, and Refactoring.
  • Batteries-Included Templates: Pre-configured templates for pytest and project settings (src/dhruv/templates/).
  • Modern CLI Foundation: Built with Typer and Rich for a robust and beautiful command-line interface.
  • Clean Architecture: Standardized src layout ready for expansion.

⚙️ Configuration & Advanced Usage

CLI Reference

Command Description
dhruv hello Prints a hello message to verify the installation.

Accessing Resources

The package includes valuable resources for development:

  • Prompts: Located in src/dhruv/prompts/. Use these to guide your AI coding assistant.
  • Templates: Located in src/dhruv/templates/. Copy these to your project root for instant configuration.

🏗️ Architecture

The project follows a modular src layout:

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

🗺️ Roadmap

  • Initial Release
  • Add more utility functions
  • Implement a command-line interface
  • Expose prompts and templates via CLI (e.g., dhruv init)

🤝 Contributing & License

Contributions are welcome! Please feel free to submit a pull request.

This project is licensed under the MIT License. See the pyproject.toml file for details.

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-1.0.0.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

dhruv-1.0.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dhruv-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4b8cc4beda15dcb98efddbecb38552e69defdf05c1ff9488696b0204b3fc060f
MD5 6d0fc02209b459d3a5a3a254c6ef80cc
BLAKE2b-256 dd696c4632ab0e1be7631e7c71807b21f6924e3acd01e0781da62886c9e04d77

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhruv-1.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-1.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for dhruv-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e82b18bc5bad4cd7fe4579df18163973c507a815572592567269f946f5eaaf
MD5 4c3cc4fdcec4c9cf2f450ea619225a68
BLAKE2b-256 7bf4045d752cac5ea2cc157db28cabb5b293c1fe9c9dfaabafc3d9ec2caa82c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for dhruv-1.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