Use cases / Write documentation and READMEs

Write documentation and READMEs

Generate complete README files, API docs, and code documentation from project descriptions. Formatted in markdown, ready to commit to your repository.

Try in Torki
Category
Developers
Feature
Chat
Model
Cosmos
Share
Copy link
1

Describe your project

Tell Torki what your project does, the tech stack, key features, and who it's for. Include installation requirements and any CLI commands if applicable.

Generate a README.md for a Python CLI tool called "dataclean" that cleans and validates CSV files. It can remove duplicates, fix date formats, fill missing values, and export to JSON. Installed via pip.

2

Get formatted documentation

Torki generates a complete README with proper markdown formatting — headings, code blocks, badges, tables, and examples. Copy it directly into your repo.

3

Generate more docs

Ask for API reference docs, CONTRIBUTING.md, CHANGELOG, architecture docs, or inline code comments. Torki adapts the format to match your project's conventions.

Torki Chat
Generate a README.md for "dataclean" — a Python CLI for cleaning CSV files. Supports dedup, date fixing, missing values, JSON export. Installed via pip.
Torki
# 🧹 dataclean

Fast, flexible CSV cleaning from the command line.

## Installation

```bash
pip install dataclean
```

## Quick Start

```bash
# Remove duplicate rows
dataclean input.csv --dedup -o clean.csv

# Fix date formats to ISO 8601
dataclean input.csv --fix-dates -o clean.csv

# Fill missing values with column median
dataclean input.csv --fill median -o clean.csv

# Export to JSON
dataclean input.csv --format json -o output.json
```

## Options

| Flag            | Description                    |
|-----------------|--------------------------------|
| `--dedup`       | Remove duplicate rows          |
| `--fix-dates`   | Normalize dates to ISO 8601    |
| `--fill MODE`   | Fill nulls (mean/median/zero)  |
| `--format FMT`  | Output format (csv/json/xlsx)  |
| `-o FILE`       | Output file path               |
| `--dry-run`     | Preview changes without saving |

## License

MIT
Ask anything...

Ready to try for yourself?

Describe your project and Torki generates formatted documentation ready for your repo.

Try in Torki