Join WhatsApp
Sample output Ā· AI-generated

# csvclean

A small command-line tool that removes duplicate rows, trims spaces and fixes date formats in CSV files.

## Quick start
```bash
git clone https://github.com/example/csvclean.git
cd csvclean
pip install -e .
csvclean data/sample.csv -o clean.csv
```
Requires Python 3.10 or newer.

## Configuration
| Variable | Required | Example | Purpose |
|---|---|---|---|
| CSVCLEAN_DATE_FORMAT | No | %Y-%m-%d | Output date format |
| CSVCLEAN_LOG_LEVEL | No | INFO | How much detail to log |

## Usage
```bash
csvclean orders.csv --dedupe-on email -o orders_clean.csv
```
Output: Removed 42 duplicate rows. Wrote 1,958 rows to orders_clean.csv.

## Troubleshooting
- "command not found: csvclean": activate your virtual environment, then run pip install -e . again.
- Dates look wrong: set CSVCLEAN_DATE_FORMAT to match your locale.
- UnicodeDecodeError: add --encoding latin-1 for files exported from older spreadsheets.

## Contributing
Open an issue before large changes. Run pytest before sending a pull request.

## Licence
MIT

Text prompt Ā· ChatGPT Ā· Claude Ā· Gemini

README prompt to document a project for new developers

Turn your project files into a clear README that gets a new developer from clone to running in minutes.

You are a technical writer for developer tools. Write a README.md for my project.

Project name: [name]
What it does and who it is for: [description]
Tech stack and requirements: [language version, dependencies, services]
How to install and run it: [commands or paste package.json scripts or Makefile]
Configuration: [environment variables and what they do]
Main features or commands: [list]
Licence: [licence]

Sections:
1. Name and one-sentence description.
2. Quick start: the fewest steps from clone to running, as copy-paste commands.
3. Configuration: a table of environment variables, whether required, and an example value (never a real secret).
4. Usage examples with expected output.
5. Troubleshooting: 3 common problems and fixes.
6. Contributing and licence.

Use Markdown headings and code blocks. Keep it short; link to separate docs for anything long. Only use commands I gave you.
Type
Text
Fill in
7 blanks
Copies
Be the first

Updated Ā· By

Tip: Ask a teammate who has never seen the project to follow the quick start while you watch silently; every pause shows a missing line.

1. CopyTap "Copy prompt" above.
2. Fill the blanksReplace each [bracket] with your own details.
3. Paste + refinePaste it into the chat, then ask for changes.

Why this prompt works

This readme prompt is built around the question every new developer asks first: how do I get this running? The quick start comes right after the one-line description, with copy-paste commands, because a README that buries setup under background makes people give up.

"Only use commands I gave you" stops the AI from inventing install steps or scripts that do not exist, a common problem with AI-written docs. The configuration table with example values, and the rule against real secrets, keeps setup clear without leaking anything sensitive.

How to use this prompt

  1. Tap "Copy prompt".
  2. Replace every part in [square brackets] with your own details.
  3. Paste it into ChatGPT or Claude and send.
  4. Ask a follow-up like "make it shorter" or "give me 3 more options" to fine-tune it.

Variations to try

Docstrings for a module

ChatGPT Claude Gemini
Add docstrings to every public function and class in this [language] module using [Google, NumPy or JSDoc] style: [paste code]. Describe parameters, return values, errors raised and one short example. Do not change any code.
Type
Text
Fill in
3 blanks
Copies
Be the first

Architecture overview for the team

ChatGPT Claude Gemini
Write a one-page architecture overview for [project]: the main components, how data flows between them, external services, and where to start reading the code. Use this folder tree and notes: [paste]. Include a simple text diagram.
Type
Text
Fill in
2 blanks
Copies
Be the first

Changelog from commits

ChatGPT Claude Gemini
Turn these commit messages into a user-facing changelog entry for version [version]: [paste commits]. Group into Added, Changed, Fixed. Skip internal refactors and write each line for users, not developers.
Type
Text
Fill in
2 blanks
Copies
Be the first

Make it your own

  • Add a "Screenshots" or "Demo" section if your project has a UI.
  • Ask for badges such as build status and licence at the top if your repository uses CI.
  • Ask for a shorter README plus a separate CONTRIBUTING.md for larger projects.

Common problems and fixes

  • The README describes features that do not exist. Paste your real scripts and commands, and keep the "only use commands I gave you" rule.
  • Setup steps fail on a fresh machine. Follow the quick start yourself in a new folder or container and fix any missing step.

FAQ

What should every README include?

What the project does, how to install and run it, how to configure it, a usage example and the licence. Everything else is optional.

Should the README be long?

Keep it short enough to scan. Move detailed guides to a docs folder and link to them.

More Coding prompts

See all
ChatGPT Claude Text prompt

Debug code prompt that finds the root cause before fixing

Paste your code and the error message to get the real cause explained first, then a small fix and a test for it.

4 prompts
ChatGPT Claude Text prompt

Explain code prompt for beginners, line by line

Paste any snippet and get a plain-English summary, a line-by-line walkthrough and the concepts you need to understand it.

4 prompts
ChatGPT Claude Text prompt

Unit test prompt for edge cases in pytest or Jest

Get a list of test cases for a function, then ready-to-run tests for normal input, edge cases and errors in your framework.

3 prompts
ChatGPT Claude Text prompt

Refactor code prompt for cleaner, more readable functions

Clean up a messy function while keeping its behaviour the same, with a short list of every change and the reason for it.

4 prompts
ChatGPT Claude Text prompt

SQL query prompt: describe your tables, get the query

Describe your tables and the question you want answered, and get a correct query for your database with a short explanation.

4 prompts
ChatGPT Claude Text prompt

Regex prompt that writes and explains a pattern with tests

Describe what you want to match and get a working pattern for your language, explained piece by piece, with examples that should and should not match.

4 prompts
ChatGPT Claude Text prompt

Code review prompt for bugs, security and readability

A structured review of a pull request or snippet, with issues sorted by severity, each tied to a line and a suggested fix.

3 prompts
ChatGPT Claude Text prompt

API design prompt for clean REST endpoints and errors

Plan a REST API for a feature: endpoints, example requests and responses, status codes, error format and the decisions behind them.

4 prompts