Skip to main content

Timeline of Events: https://irantimelines.com/
Read wiki: https://en.wikipedia.org/wiki/Mahsa_Amini_protests
Or watch YouTube: https://www.youtube.com/watch?v=wZpkmUx4RFc

But, please don't scroll passed this.
Innocent lives need your voice.

Start by following #MahsaAmini on Twitter.

DocGPT

DocGPT (docgpt) is a CLI tool that automatically generates documentation for code.

👉 All the in-code documentation of docgpt project are generated with docgpt! So meta! 👈

Installation

pip install docgpt

API Key

DocGPT depends on the GPT3 model, hence the name, trained and served by OpenAI.
Register for an account and get your API key here: https://openai.com/api/
Check OpenAI's Pricing and use it responsibly (roughly speaking, auto-documenting 4 pages of code with docgpt costs $0.05 USD).

Set the OPENAI_API_KEY environment variable, or specify via --api_key flag. The key will get cached in ~/.docgpt for future use.

Usage

# conventional use
docgpt <source> --target <target>

# piped
cat <source> | docgpt --target <target>

# overwrite
docgpt <source> --overwrite

To see available options try docgpt --help

Contributing

DocGPT is GNU GPL licensed and we intend to keep it purely open-source. We welcome contributions to docgpt. Your forks and pull-requests are always welcome.

To open a feature request or report a bug, please open an issue here.

Cause

DocGPT is open-sourced as part of the global action in solidarity with Iranians who are courageously demonstrating peacefully for their human rights.

Metadata

Release files for docgpt 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docgpt 0.1.2
File Size Uploaded
docgpt-0.1.2.tar.gz 230.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for docgpt 0.1.2
File Interpreter ABI Platform
docgpt-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 263.9 kB

Release files / docgpt-0.1.2.tar.gz

Download URL docgpt-0.1.2.tar.gz
Size 230.8 kB
Tags Source
SHA-256 checksum
How to use checksums
5dd84fee1a54ea137dde6ab578028ef4fc3fccdfe3ae0a64dd6eaafb245efd40
BLAKE2b-256 checksum
How to use checksums
fbdbd9f79ec9308cdaa2ced8f19d176af6e7d3271979263ee00c714dfdf1af73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.9

Release files / docgpt-0.1.2-py3-none-any.whl

Download URL docgpt-0.1.2-py3-none-any.whl
Size 33.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a6bca91f1e736c787b309d757769e908d4c17de1ed4f7908c6056f49901adf1b
BLAKE2b-256 checksum
How to use checksums
af2164ba4048f81aa3d022ee03902be1b86bdd6338d91e617d5e4c4016a25964
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.9

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page