semvec/pypi-packages huggingface dataset:
autodocz 3.4
A CLI tool to generate documents related to user projects
License: MIT
Requires Python: >=3.9
Keywords: readme, directory, cli

# autodocz

**autodocz** is a lightweight Python package that generates project documentation files such as `README.md`, `LICENSE`, and a professional project `REPORT.docx` using a simple CLI interface.

Whether you're kickstarting a new project or preparing for submission, `autodocz` helps automate and standardize your documentation process.

---

## 📦 Installation

You can install `autodocz` directly from PyPI:

```bash
pip install autodocz
```

---

## 🔑 Configuration

Before using `autodocz`, you must provide your GROQ API key so the tool can interact with the Groq chat service. You can supply the key in one of two ways:

1. **Environment variable** (recommended):
   ```bash
   export GROQ_API_KEY="your_groq_api_key_here"
   ```
   - On Windows PowerShell:
     ```powershell
     $env:GROQ_API_KEY = "your_groq_api_key_here"
     ```

2. **CLI flag**: pass it when you run the command:
   ```bash
   autodocz generate all --api-key your_groq_api_key_here
   ```

If you do not provide a key, `autodocz` will exit with an error and prompt you to set one.

---

## 🚀 Usage

After installation and configuration, you can use the CLI tool via the terminal.

### Generate a Specific Document

```bash
autodocz generate readme
```

Generates a `README.md` file.

```bash
autodocz generate license
```

Generates a `LICENSE` file.

```bash
autodocz generate report
```

Generates a professional `REPORT.docx` file (in MS Word format).

### Generate All Documents

```bash
autodocz generate all
```

Generates all three files: `README.md`, `LICENSE`, and `REPORT.docx`.

### Specify Output Filename/Path

```bash
autodocz generate readme -o MyReadme.md
```

---

## 📁 Output Files

- `README.md` — Standard project introduction with sections like Installation, Usage, Features, etc.
- `LICENSE` — A default license template.
- `REPORT.docx` — A formal report document containing project summary, introduction, features, future work, contributions, etc.

---

## 🛠️ Requirements

- Python 3.9+
- A valid GROQ API key

---

## 🤝 Author

Made with ❤️ by Fatima Mansoor  
fatima.mansoorali03@gmail.com

---

## 📌 Example

```bash
$ autodocz generate report --api-key {apikey}
✅ Generated REPORT.docx
```

---

Happy documenting! 📝