Metadata-Version: 2.4
Name: autodocz
Version: 2.6
Summary: A CLI tool to generate documents related to user projects
Author-email: Fatima Mansoor <fatima.mansoorali03@gmail.com>
License: MIT
Keywords: readme,directory,cli
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: groq
Requires-Dist: python-dotenv
Dynamic: license-file

# 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
```

---

## 🚀 Usage

After installation, 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.7+
- `python-docx` (automatically installed as a dependency)

---

## 👨‍💻 Contributing

Contributions, feature requests, and issues are welcome!

1. Fork the repo
2. Create your feature branch: `git checkout -b feature/my-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin feature/my-feature`
5. Open a pull request

---

## 📃 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

## 🤝 Author

Made with ❤️ by [Your Name]  
GitHub: [your-github-profile]  
PyPI: [autodocz on PyPI]

---

## 📌 Example

```bash
$ autodocz generate report
✅ Generated REPORT.docx
```

---

Happy documenting! 📝
