pydolce 0.1.1

The sweet way to catch outdated docstrings

Dolce

Because broken docs leave a bitter taste.

Dolce is a tool designed to help you maintain high-quality docstrings in your Python code. It leverages Large Language Models (LLMs) to ensure that your docstrings are consistent with your code.

Installation

pip install pydolce

Usage

dolce check # Check docstrings in all python files in the current directory and subdirectories
dolce check src # Check in specific directory
dolce check src/myproject/main.py # Check in specific file

Configure

By default dolce will try to run locally codestral model via ollama provider. If you want to use a different LLM or provider you can configure the default options in the pyproject.toml:

[tool.dolce]
url = "http://localhost:11434"
model = "codestral"
provider = "ollama"
api_key = "YOUR_API_KEY_ENVIROMENT_VAR"

To be implemented

• Add cache system to avoid re-checking unchanged code
• Integrate third-party tools to check docstrings style, parameters, etc.
• Support for ignoring specific code segments, files, directories, etc
• Support parallel requests ... much more!

---

📦 For Developers

Make sure you have the following tools installed before working with the project:

• uv → Python project and environment management
• make → run common project tasks via the Makefile

Getting Started

Install dependencies into a local virtual environment:

uv sync --all-groups

This will create a .venv folder and install everything declared in pyproject.toml.

Then, you can activate the environment manually depending on your shell/OS:

• Linux / macOS (bash/zsh):

  source .venv/bin/activate
  

• Windows (PowerShell):

  .venv\Scripts\Activate.ps1
  

• Windows (cmd.exe):

  .venv\Scripts\activate.bat
  

Running

uv run dolce check path/to/your/code

Linting, Formatting, and Type Checking

make qa

Runs Ruff for linting and formatting, and Mypy for type checking.

Running Unit Tests

Before running tests, override any required environment variables in the .env.test file.

make test

Executes the test suite using Pytest.

Building the Project

make build

Generates a distribution package inside the dist/ directory.

Cleaning Up

make clean

Removes build artifacts, caches, and temporary files to keep your project directory clean.

Building docs

make docs

Generates the project documentation inside the dist/docs folder.

When building the project (make build) the docs will also be generated automatically and included in the distribution package.

🤝 Contributing

Contributions are welcome! Please ensure all QA checks and tests pass before opening a pull request.

---

_{🚀 Project starter provided by Cookie Pyrate}