| Name | autodocz JSON |
| Version |
3.4
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to generate documents related to user projects |
| upload_time | 2025-07-22 07:51:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
readme
directory
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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! 📝
Raw data
{
"_id": null,
"home_page": null,
"name": "autodocz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "readme, directory, cli",
"author": null,
"author_email": "Fatima Mansoor <fatima.mansoorali03@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/e6/86e27a6bec14ea8e6b61f526da4578f1c499e09f98030e83be32aa24e9af/autodocz-3.4.tar.gz",
"platform": null,
"description": "# autodocz\r\n\r\n**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.\r\n\r\nWhether you're kickstarting a new project or preparing for submission, `autodocz` helps automate and standardize your documentation process.\r\n\r\n---\r\n\r\n## \ud83d\udce6 Installation\r\n\r\nYou can install `autodocz` directly from PyPI:\r\n\r\n```bash\r\npip install autodocz\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udd11 Configuration\r\n\r\nBefore 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:\r\n\r\n1. **Environment variable** (recommended):\r\n ```bash\r\n export GROQ_API_KEY=\"your_groq_api_key_here\"\r\n ```\r\n - On Windows PowerShell:\r\n ```powershell\r\n $env:GROQ_API_KEY = \"your_groq_api_key_here\"\r\n ```\r\n\r\n2. **CLI flag**: pass it when you run the command:\r\n ```bash\r\n autodocz generate all --api-key your_groq_api_key_here\r\n ```\r\n\r\nIf you do not provide a key, `autodocz` will exit with an error and prompt you to set one.\r\n\r\n---\r\n\r\n## \ud83d\ude80 Usage\r\n\r\nAfter installation and configuration, you can use the CLI tool via the terminal.\r\n\r\n### Generate a Specific Document\r\n\r\n```bash\r\nautodocz generate readme\r\n```\r\n\r\nGenerates a `README.md` file.\r\n\r\n```bash\r\nautodocz generate license\r\n```\r\n\r\nGenerates a `LICENSE` file.\r\n\r\n```bash\r\nautodocz generate report\r\n```\r\n\r\nGenerates a professional `REPORT.docx` file (in MS Word format).\r\n\r\n### Generate All Documents\r\n\r\n```bash\r\nautodocz generate all\r\n```\r\n\r\nGenerates all three files: `README.md`, `LICENSE`, and `REPORT.docx`.\r\n\r\n### Specify Output Filename/Path\r\n\r\n```bash\r\nautodocz generate readme -o MyReadme.md\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udcc1 Output Files\r\n\r\n- `README.md` \u2014 Standard project introduction with sections like Installation, Usage, Features, etc.\r\n- `LICENSE` \u2014 A default license template.\r\n- `REPORT.docx` \u2014 A formal report document containing project summary, introduction, features, future work, contributions, etc.\r\n\r\n---\r\n\r\n## \ud83d\udee0\ufe0f Requirements\r\n\r\n- Python 3.9+\r\n- A valid GROQ API key\r\n\r\n---\r\n\r\n## \ud83e\udd1d Author\r\n\r\nMade with \u2764\ufe0f by Fatima Mansoor \r\nfatima.mansoorali03@gmail.com\r\n\r\n---\r\n\r\n## \ud83d\udccc Example\r\n\r\n```bash\r\n$ autodocz generate report --api-key {apikey}\r\n\u2705 Generated REPORT.docx\r\n```\r\n\r\n---\r\n\r\nHappy documenting! \ud83d\udcdd\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool to generate documents related to user projects",
"version": "3.4",
"project_urls": null,
"split_keywords": [
"readme",
" directory",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "11a4c7d38e0df61a85ce30c644ddba897f3a195c7c243175f100272c7ae3b965",
"md5": "f0990bd4670135b2ca1df0dc6076a0e9",
"sha256": "daecc4556b83e3c7dffcc53656c6ee909e34229de537a8d2836beae4eb8788f3"
},
"downloads": -1,
"filename": "autodocz-3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f0990bd4670135b2ca1df0dc6076a0e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7124,
"upload_time": "2025-07-22T07:51:04",
"upload_time_iso_8601": "2025-07-22T07:51:04.277593Z",
"url": "https://files.pythonhosted.org/packages/11/a4/c7d38e0df61a85ce30c644ddba897f3a195c7c243175f100272c7ae3b965/autodocz-3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "85e686e27a6bec14ea8e6b61f526da4578f1c499e09f98030e83be32aa24e9af",
"md5": "5fe0f940303ad75c658f84bab05ff858",
"sha256": "f45957bbf836b0ebab094c4a05508c4b75d900b017a6e822f3fc5ef9e92d241a"
},
"downloads": -1,
"filename": "autodocz-3.4.tar.gz",
"has_sig": false,
"md5_digest": "5fe0f940303ad75c658f84bab05ff858",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6402,
"upload_time": "2025-07-22T07:51:05",
"upload_time_iso_8601": "2025-07-22T07:51:05.484926Z",
"url": "https://files.pythonhosted.org/packages/85/e6/86e27a6bec14ea8e6b61f526da4578f1c499e09f98030e83be32aa24e9af/autodocz-3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 07:51:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "autodocz"
}
