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:
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:
-
Environment variable (recommended):
export GROQ_API_KEY="your_groq_api_key_here"
- On Windows PowerShell:
$env:GROQ_API_KEY = "your_groq_api_key_here"
- On Windows PowerShell:
-
CLI flag: pass it when you run the command:
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
autodocz generate readme
Generates a README.md file.
autodocz generate license
Generates a LICENSE file.
autodocz generate report
Generates a professional REPORT.docx file (in MS Word format).
Generate All Documents
autodocz generate all
Generates all three files: README.md, LICENSE, and REPORT.docx.
Specify Output Filename/Path
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
$ autodocz generate report --api-key {apikey}
✅ Generated REPORT.docx
Happy documenting! 📝
1 maintainer
Metadata
1 maintainer
Release files for autodocz 3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| autodocz-3.4.tar.gz | 6.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autodocz-3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.5 kB
Release files / autodocz-3.4.tar.gz
| Download URL | autodocz-3.4.tar.gz |
|---|---|
| Size | 6.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f45957bbf836b0ebab094c4a05508c4b75d900b017a6e822f3fc5ef9e92d241a
|
|
BLAKE2b-256 checksum How to use checksums |
85e686e27a6bec14ea8e6b61f526da4578f1c499e09f98030e83be32aa24e9af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.8
|
Release files / autodocz-3.4-py3-none-any.whl
| Download URL | autodocz-3.4-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
daecc4556b83e3c7dffcc53656c6ee909e34229de537a8d2836beae4eb8788f3
|
|
BLAKE2b-256 checksum How to use checksums |
11a4c7d38e0df61a85ce30c644ddba897f3a195c7c243175f100272c7ae3b965
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.8
|
Security for autodocz 3.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
