Initial project setup and documentation

- Add project structure and configuration files
- Set up CI/CD workflow
- Add comprehensive documentation
- Configure development tools (.pre-commit, tox, flake8)

Closes #1
Closes #2
Closes #3

Author: ritwik-g

.flake8

@@ -0,0 +1,11 @@
+[flake8]
+max-line-length = 100
+exclude =
+    .tox,
+    .git,
+    __pycache__,
+    build,
+    dist,
+    *.egg,
+    venv
+extend-ignore = E203, W503

.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions
+
+    - name: Test with tox
+      run: tox
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: true
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run linting
+      run: tox -e lint

.gitignore

@@ -169,3 +169,11 @@ cython_debug/
 
 # PyPI configuration file
 .pypirc
+
+# Generated plugin files
+bin/
+
+# macOS specific
+.DS_Store
+.AppleDouble
+.LSOverride

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: debug-statements
+    -   id: check-case-conflict
+
+-   repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+    -   id: black
+        language_version: python3
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+        name: isort (python)
+
+-   repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-docstrings]

CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing to Helm Values Manager
+
+We love your input! We want to make contributing to Helm Values Manager as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Development Process
+
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code passes all code quality checks.
+6. Issue that pull request!
+
+## Development Setup
+
+1. Clone your fork:
+```bash
+git clone https://github.com/YOUR-USERNAME/helm-values-manager
+cd helm-values-manager
+```
+
+2. Create a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: .\venv\Scripts\activate
+```
+
+3. Install development dependencies:
+```bash
+pip install -e ".[dev]"
+```
+
+4. Install pre-commit hooks:
+```bash
+pre-commit install
+```
+
+## Code Quality Standards
+
+We use several tools to maintain code quality:
+
+### Pre-commit Hooks
+
+We use pre-commit to run various checks before each commit. The hooks include:
+
+- Code formatting with `black`
+- Import sorting with `isort`
+- Style guide enforcement with `flake8`
+- YAML validation
+- Check for large files
+- Debug statement checks
+- Case conflict checks
+- Trailing whitespace removal
+- End of file fixes
+
+To run all checks manually:
+```bash
+pre-commit run --all-files
+```
+
+### Testing
+
+We use `pytest` for testing and `tox` for testing against multiple Python versions.
+
+Run all tests:
+```bash
+tox
+```
+
+Run tests for a specific Python version:
+```bash
+tox -e py39  # For Python 3.9
+```
+
+### Documentation
+
+- Use docstrings for all public modules, functions, classes, and methods
+- Follow Google style for docstrings
+- Keep the README.md and other documentation up to date
+
+## Pull Request Process
+
+1. Update the README.md with details of changes to the interface, if applicable.
+2. Update the documentation with any new features or changes.
+3. The PR may be merged once you have the sign-off of at least one maintainer.
+
+## Any contributions you make will be under the MIT Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using GitHub's [issue tracker](https://github.com/zipstack/helm-values-manager/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/zipstack/helm-values-manager/issues/new).
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.

README.md

@@ -1,80 +1,105 @@
-# **🚧 This is a work in progress not yet released for usage**
+# Helm Values Manager
 
+🚀 A powerful Helm plugin for managing values and secrets across multiple environments.
 
-# **Helm Values Manager 🚀**
-🔐 **Secure & Manage Helm Configurations and Secrets Easily!**
+## Features
 
-Helm Values Manager is a **Helm plugin** designed to simplify **configuration and secret management** across multiple **Kubernetes deployments**. It provides an intuitive **CLI** to define, validate, and securely store configuration values for Helm-based applications.
+- 🔐 **Secure Secret Management**: Safely handle sensitive data
+- 🌍 **Multi-Environment Support**: Manage values for dev, staging, prod, and more
+- 🔄 **Value Inheritance**: Define common values and override per environment
+- 🔍 **Secret Detection**: Automatically identify and protect sensitive data
+- 📦 **Easy Integration**: Works seamlessly with existing Helm workflows
 
----
+## Requirements
 
-## **✨ Features**
-- 🔴 **Deployment-Aware Configuration Management** – Define **global and per-environment configurations**.
-- 🔴 **Secure Secret Storage** – Integrates with
-    - 🔴 **Google Secret Manager**
-    - 🔴 **AWS Secrets Manager**
-    - 🔴 **Azure Key Vault**
-    - 🔴 **HashiCorp Vault**
-    - 🔴 **Git-Secrets**
-    - 🔧 **Easily Extendable** – Implement your own backend using the **SecretManager API**.
-- 🔴 **Autocompletion Support** – Smooth CLI experience with **Typer-based interactive commands**.
-- 🔴 **Validation & Missing Keys Detection** – Avoid misconfigurations with **automated checks**.
-- 🔴 **Extensible Secret Manager** – Easily add new **custom backends** for secret storage.
-- 🔴 **Seamless ArgoCD & Helm Integration** – Works **out-of-the-box** with Helm-based GitOps workflows.
+- Python 3.8 or higher
+- Helm 3.x
+- pip (Python package installer)
 
----
+## Installation
 
-## **🚀 Quick Start**
-1️⃣ **Install the Helm Plugin**
-```sh
-helm plugin install https://github.com/your-org/helm-values-manager.git
+```bash
+helm plugin install https://github.com/zipstack/helm-values-manager
 ```
 
-2️⃣ **Initialize a New Configuration**
-```sh
-helm values-manager init my-release
+## Quick Start
+
+1. Initialize a new configuration:
+```bash
+helm values-manager init
+```
+
+This creates:
+- `values-manager.yaml` configuration file
+- `values` directory with environment files (`dev.yaml`, `staging.yaml`, `prod.yaml`)
+
+2. View available commands:
+```bash
+helm values-manager --help
 ```
 
-3️⃣ **Define a Deployment & Add Keys**
-```sh
-helm values-manager add-deployment dev --secrets-backend=aws_secrets_manager
-helm values-manager add-key DATABASE_URL --required --sensitive --path=global.database.url
+## Development
+
+### Setup Development Environment
+
+1. Clone the repository:
+```bash
+git clone https://github.com/zipstack/helm-values-manager
+cd helm-values-manager
 ```
 
-4️⃣ **Set & Retrieve Secret Values**
-```sh
-helm values-manager add-secret DATABASE_URL=mydb://connection --deployment=dev
-helm values-manager get-secret DATABASE_URL --deployment=dev
+2. Create and activate a virtual environment:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: .\venv\Scripts\activate
 ```
 
-5️⃣ **Validate Configurations**
-```sh
-helm values-manager validate
+3. Install development dependencies:
+```bash
+pip install -e ".[dev]"
 ```
 
-6️⃣ **Generate the Final `values.yaml`**
-```sh
-helm values-manager generate --deployment=dev
+4. Install pre-commit hooks:
+```bash
+pre-commit install
 ```
 
----
+### Running Tests
+
+Run tests with tox (will test against multiple Python versions):
+```bash
+tox
+```
+
+Run tests for a specific Python version:
+```bash
+tox -e py39  # For Python 3.9
+```
+
+### Code Quality
+
+This project uses several tools to maintain code quality:
+
+- **pre-commit**: Runs various checks before each commit
+- **black**: Code formatting
+- **isort**: Import sorting
+- **flake8**: Style guide enforcement
+
+Run all code quality checks manually:
+```bash
+pre-commit run --all-files
+```
 
-## **📜 Documentation**
-📖 **[Read the Full Documentation](https://github.com/your-org/helm-values-manager/wiki)**
-💡 **[View the Architecture Decision Record (ADR)](https://github.com/your-org/helm-values-manager/wiki/ADRs/001-helm-values-manager.md)**
-🛠 **[Contribute to the Project](https://github.com/your-org/helm-values-manager/wiki/Contribution/contributing.md)**
+## Contributing
 
----
+🙌 PRs and contributions are welcome! Let's build a better Helm secret & config manager together.
 
-## **🤝 Contributing**
-Want to help? Check out our **[contribution guidelines](https://github.com/your-org/helm-values-manager/wiki/Contribution/contributing.md)**! We welcome issues, PRs, and feature suggestions. 🎉
+Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project.
 
----
+## 📌 License
 
-## **📌 License**
 🔓 Open-source under the **MIT License**.
 
----
+### 🌟 Star this repo if you find it useful! 🌟
 
-### **🌟 Star this repo if you find it useful! 🌟**
-🙌 PRs and contributions are welcome! Let's build a better **Helm secret & config manager** together. 🚀
+[![Star](https://img.shields.io/github/stars/zipstack/helm-values-manager?style=social)](https://github.com/zipstack/helm-values-manager)

helm_values_manager/__init__.py

@@ -0,0 +1,11 @@
+"""A Helm plugin to manage values and secrets across environments."""
+
+__version__ = "0.1.0"
+__description__ = "A Helm plugin to manage values and secrets across environments."
+
+from .cli import app
+
+
+def helm_values_manager():
+    """Entry point for the Helm plugin."""
+    app()