Automatically generate high-quality README for your application
Project description
Dokugen Python Client (Coming Soon 🚧)
Note: The Python packaging and distribution for Dokugen is currently under active development. The installation instructions below are a preview of the upcoming release.
Dokugen is a lightweight README.md file Generator Command Line Interface Tool. It simplifies the process of writing your README.md file from scratch by generating professional README.md files for your projects, saving you time and ensuring consistency using AI.
Installation
Prerequisites
- Python 3.8+
- uv (Recommended) or pip
Install with uv (Recommended)
# Coming Soon
uv pip install dokugen
# or
uv tool install dokugen
Install with pip
# Coming Soon
pip install dokugen
Usage
Navigate to the project you want to work with
cd my-project
Generate a new README interactively
# Coming Soon
dokugen generate
# or
python -m dokugen generate
This command launches an interactive prompt to guide you through creating a professional README file.
Standalone Binaries (Experimental)
[!WARNING] Experimental Vibes: These standalone binaries are super new and honestly pretty unstable. If you use them, you’ll probably run into issues, that’s just how it is right now. If it breaks, just stick to the Node.js and Python version for now.
You can also try our standalone binaries if you don't want to install Python or Node.js.
Windows Download dokugen-windows-x64.exe
macOS (Apple Silicon M1/M2/M3) Download dokugen-macos-arm64
macOS (Intel) Download dokugen-macos-x64
Linux Download dokugen-linux-x64
License
This project is licensed under the MIT License - see the LICENSE file for details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dokugen-3.12.1.tar.gz.
File metadata
- Download URL: dokugen-3.12.1.tar.gz
- Upload date:
- Size: 16.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b6aafcb510b8464c6d6bc8b7442540b0558a340516fcf65902a6b1cf182bc4d
|
|
| MD5 |
bd8341106eee18200dcf460f4f7b7716
|
|
| BLAKE2b-256 |
133e32011f0d26f1b646c12254f3b6bc952771a2242a26d510206caacfabd2d4
|
File details
Details for the file dokugen-3.12.1-py3-none-any.whl.
File metadata
- Download URL: dokugen-3.12.1-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b63229e51be6e79b8d432fb7b9d45005df5911af4f0bc26aa642c97283c72d85
|
|
| MD5 |
29c1fcfabb2dc859d825e9247837f4ad
|
|
| BLAKE2b-256 |
026558d94c10f4eda55d3a67c52fd47219ddef64e975b1aee4dee5a43dd6e009
|
