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 designed for simplicity and extensibility.

About

This project serves as a lightweight, "batteries-included" starting point for new Python packages. It demonstrates a clean project structure and basic packaging, making it easy to build upon.


🚀 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

Here's how to use the core function of this package:

from dhruv.main import hello

print(hello())
# Expected Output: "Hello from Dhruv!"

✨ Key Features

  • Zero Dependencies: No external packages required.
  • Easy to Install: Get up and running with a single command.
  • Extensible: A solid foundation for building more complex applications.

⚙️ Configuration & Advanced Usage

Currently, the package requires no special configuration or environment variables.


🏗️ Architecture

The project follows a standard src layout:

.
├── src
│   └── dhruv
│       ├── __init__.py
│       └── main.py
├── tests
└── pyproject.toml

The core logic resides in src/dhruv/main.py, which is the primary entry point for the package's functionality.


🗺️ Roadmap

  • Initial Release
  • Add more utility functions
  • Implement a command-line interface

🤝 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-0.1.2.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

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

dhruv-0.1.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dhruv-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b5a04ccff2ab18c97d1d1ec9e516e769a66fcafd3e6d8c4ff37c0eedec8bb12f
MD5 f10f8b3a08bdbf70b8138786e2b4d812
BLAKE2b-256 c93a7c7b682d0f646ae5c6da618849206e40daeb092ccd4cea5125785436bcb4

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for dhruv-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fbdd70b9fe6c0a97f4d979c957f3aef8b2e9c5fdc0ef957217987c9769e30f4c
MD5 dcb0152091487d04f0d399648b54ab9d
BLAKE2b-256 47ab44b96ea7e0163e806106946ea00d5577abfb80dcf97e21a35358dc59745b

See more details on using hashes here.

Provenance

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