Skip to content

A CLI Tool that generates production-ready DevOps repositories based on user-selected options like CI/CD, infrastructure, deployment, environments, observability, and security.

License

Notifications You must be signed in to change notification settings

NotHarshhaa/devops-project-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ DevOps Project Generator πŸš€

A powerful CLI tool that scaffolds production-ready DevOps repositories with ease, allowing you to quickly bootstrap complete DevOps projects by selecting user-friendly options for CI/CD, infrastructure, deployment, environments, observability, and security.

✨ Why DevOps Project Generator?

Setting up a real-world DevOps project from scratch is repetitive and error-prone. This tool helps you bootstrap a complete DevOps-ready repository in seconds, following industry best practices.

βœ” Opinionated but configurable
βœ” Beginner-friendly, production-oriented
βœ” CLI support
βœ” No tool lock-in

🎯 Who Is This For?

  • DevOps Engineers
  • Cloud Engineers
  • Platform Engineers
  • SREs
  • Students & freshers building real DevOps projects

🌟 Key Features

  • Fast project generation
  • Interactive setup
  • Configurable tech stack
  • Best practices project structure
  • Browse and create templates
  • Save configurations as profiles
  • Integration testing
  • Project health analysis
  • Backup and restore
  • Advanced project management
  • Dependency scanning
  • Multi-environment config generator

πŸ–₯️ Usage

Quick Start

# Install
pip install devops-project-generator

# Generate a project
devops-project-generator init --name my-app --ci github-actions --deploy docker

# Scan dependencies (NEW v1.5.0)
devops-project-generator scan my-app

# Setup multi-environment configs (NEW v1.5.0)
devops-project-generator multi-env my-app --envs "dev,stage,prod"

Documentation

🧠 What This Generator Creates

A full DevOps project structure covering:

  • CI/CD pipelines
  • Containerization
  • Infrastructure (IaC-ready)
  • Deployment models
  • Environment separation
  • Observability
  • Security basics

All generated based on your selected options.

βš™οΈ Supported Options (v1.5.0)

CI/CD

  • GitHub Actions
  • GitLab CI
  • Jenkins
  • None

Infrastructure

  • Terraform
  • CloudFormation
  • None

Deployment

  • VM
  • Docker
  • Kubernetes

Environments

  • Single
  • Dev / Stage / Prod

Observability

  • Logs only
  • Logs + Metrics
  • Full (Logs + Metrics + Alerts)

Security

  • Basic
  • Standard
  • Strict

πŸ“¦ Installation

From PyPI

pip install devops-project-generator

From Source

git clone https://github.com/NotHarshhaa/devops-project-generator.git
cd devops-project-generator
pip install -e .

Development Setup

git clone https://github.com/NotHarshhaa/devops-project-generator.git
cd devops-project-generator
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[dev]"

πŸ—οΈ Generated Project Structure

devops-project/
β”œβ”€β”€ app/
β”œβ”€β”€ ci/
β”œβ”€β”€ infra/
β”œβ”€β”€ k8s/
β”œβ”€β”€ config/              # NEW: Multi-environment configs
β”œβ”€β”€ docker/              # NEW: Docker Compose configs
β”œβ”€β”€ monitoring/
β”œβ”€β”€ security/
β”œβ”€β”€ scripts/
β”œβ”€β”€ Makefile
└── README.md

For detailed structure information, see the Templates Guide.

Project Templates

The generator supports custom templates. See the Templates Guide for detailed information on creating and customizing templates.

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Run the test suite
  6. Submit a pull request

Getting Help

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • Typer - For the amazing CLI framework
  • Rich - For beautiful terminal output
  • Jinja2 - For powerful templating
  • DevOps Community - For best practices and inspiration

πŸ“ž Contact

This project is crafted with πŸ’‘ by Harshhaa.
Your feedback is always welcome! Let's build together. πŸš€

πŸ“§ Connect with me:
πŸ”— GitHub: @NotHarshhaa
πŸ”— Portfolio: Personal Portfolio
πŸ”— Links - Portfolio: Links
πŸ”— Telegram Community: Join Here
πŸ”— LinkedIn: Harshhaa Vardhan Reddy


Built with ❀️ by the DevOps community
Making DevOps accessible to everyone

About

A CLI Tool that generates production-ready DevOps repositories based on user-selected options like CI/CD, infrastructure, deployment, environments, observability, and security.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors