PyDocStrGen: Context-Aware Python Docstring Generator using GenAI

PyDocStrGen acts as an intelligent assistant, helping development teams overcome the common hurdles of writing and maintaining high-quality, consistent, and up-to-date documentation:

• Modernize Legacy Code: Introduce high-quality documentation to aging codebases quickly and efficiently.
• Enforce Consistency: Ensure uniform documentation styles across development teams, promoting readability and maintainability.
• Improve Onboarding: Enhance code readability to significantly reduce the learning curve for engineers.
• Achieve Release Readiness: Guarantee documentation coverage for SDKs, public releases and audit compliance requirements.
• Automate Research Code Documentation: Automatically document machine learning or research code during early development stages, freeing up valuable developers time.

HOW IT WORKS:

The solution operates on simple "S3 in, S3 out" model. Provide your source code archives (e.g. .zip, .tar, .tar.gz, .tar.bz2, .tar.xz files) in an S3 bucket and PyDocStrGen processes them, uploading the documented version back to the same S3 bucket and path in the original format.

KEY FEATURES:

• Context-Aware Docstrings: Generates accurate context-rich docstrings by leveraging your README.md files and other supporting documentation or an Amazon Bedrock Knowledge Base ID.
• Secure In-Account Execution: All code processing and execution occurs entirely within your AWS account ensuring no code leaves your cloud perimeter beyond the Bedrock API call.
• Flexible Style Adherence: Supports multiple docstring styles, including Google, NumPy, and PEP 257, dynamically applying them based on user input.
• Developer-Friendly CLI: Offers a simple, standalone command-line interface (CLI) that requires no complex CI/CD pipeline or third-party tool integration.

PyDocStrGen safely parses code to extract classes, methods, parameters and existing docstrings, enriches context using uploaded documentation like README.md, and uses Amazon Bedrock for AI inference to generate and inject high-quality, contextual docstrings back into source files replacing only when improvements are needed.

DEPLOYMENT OVERVIEW

Deployment is streamlined via an AWS CloudFormation template, orchestrating the launch of a single EC2 instance into your AWS account. This instance comes pre-configured with the PyDocStrGen CLI tool, Python 3.13, AWS SDKs and a pre-configured IAM Role for secure, least-privilege access to necessary AWS services (e.g., S3, Bedrock).

• Deployment Options: The standard model is a single EC2 instance in one Availability Zone suitable for its on-demand, batch-processing nature. Multi-AZ or Multi-Region deployments are not applicable as it's a CLI-based single-instance tool. The CloudFormation template supports deployment into either a new VPC or an existing customer-managed VPC and private subnets ensuring no direct internet ingress to core components.
• Network Security: A dedicated Security Group denies all inbound traffic. All outbound HTTPS (port 443) traffic to AWS service endpoints (like Amazon Bedrock and Amazon S3) is allowed via a NAT Gateway.
• Data Protection: The solution prioritizes data confidentiality. All data in transit between the EC2 instance and AWS services (SSM, Bedrock, S3, CloudWatch) is encrypted using TLS 1.2 or higher. Server-side encryption (SSE-S3 AES-256) is enforced for new S3 buckets. While the root EBS volume is not encrypted by default to offer flexibility, customers can easily enable encryption using AWS default or custom KMS keys. Customer source code is processed entirely within their secure AWS environment with strict controls to prevent unauthorized egress.

OPERATIONAL EXCELLENCE:

• Monitoring: Health is monitored via Amazon CloudWatch which collects application logs (streamed from /var/log/pydocstrgen/app.log) and custom metrics like files processed and Bedrock API latency.
• Upgrades & Patching: Software upgrades involve subscribing to new AMI versions and updating the CloudFormation stack. Automated OS patching is recommended via AWS Systems Manager Patch Manager.
• Backup & Recovery: The EC2 instance is stateless, allowing recovery by launching a new instance from the CloudFormation template without data loss. Customers are responsible for managing versioning and backups for their source code in S3.