envguard-bin 1.0.3__tar.gz

envguard_bin-1.0.3/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: envguard-bin
+Version: 1.0.3
+Summary: The ESLint for environment variables
+Author: Vamshavardhan50
+License: MIT
+Project-URL: Homepage, https://github.com/Vamshavardhan50/envguard
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# envguard 🛡️
+
+[![CI](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml)
+[![Release](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Think of `envguard` as a spell-checker/linter for your environment variables.** 
+> It scans your code, checks your `.env` files, and makes sure you never break your app in production due to a missing or misconfigured setting. It is fast, works 100% offline, and requires zero configuration to start.
+
+---
+
+## What is envguard?
+Have you ever deployed an app, only for it to immediately crash because you forgot to copy a new API key to the server? Or because someone configured `PORT` as a word instead of a number?
+
+`envguard` solves this by automatically finding all environment variables your code uses (like `process.env.DATABASE_URL` or `os.environ.get('PORT')`) and checking them against your `.env` configuration file. It warns you immediately about:
+- ❌ **Missing variables** that your code expects but are not configured.
+- ⚠️ **Unused variables** in `.env` that your code doesn't actually use.
+- 🚫 **Invalid formats** (e.g. database URLs that are not valid URLs, or ports that are not numbers).
+
+---
+
+## ⚡ Quick 1-Minute Start
+
+Get up and running in three simple steps:
+
+### 1. Install it
+Run the install command for your favorite package manager:
+
+```bash
+# Using Node (NPM)
+npm install -g envguard-bin
+
+# Using Python (PIP)
+pip install envguard
+
+# Using Go
+go install github.com/Vamshavardhan50/envguard@latest
+```
+
+### 2. Set it up
+Run the setup wizard in your project folder. It will scan your project, find your environment variables, and create a safe configuration file (`.envguard.yaml`) for you:
+
+```bash
+envguard init
+```
+
+### 3. Guard your project
+Scan your project to find any discrepancies:
+
+```bash
+envguard audit
+```
+
+---
+
+## 🔒 Security & Privacy First
+
+- **100% Offline:** `envguard` never makes network requests and never uploads anything.
+- **Privacy-Engineered:** It only reads and displays the **names** of the keys (e.g. `STRIPE_API_KEY`). It **never** reads, logs, or prints the actual secret values.
+
+---
+
+## 🛠️ How to Use: Common Tasks
+
+Here is how to run `envguard`'s most common commands in your project:
+
+### 🔍 Find Missing or Unused Keys
+To check if your local `.env` file matches what your code actually uses, run:
+```bash
+envguard audit
+```
+*Tip: In your CI/CD pipelines, run `envguard audit --ci` to automatically fail build pipelines if keys are missing.*
+
+---
+
+### 🛡️ Check If Values Are Correct (Validation)
+You can define rules in `.envguard.yaml` (e.g., checking if `DATABASE_URL` is a valid URL, or `PORT` is a number). To validate your current configuration against these rules, run:
+```bash
+envguard validate
+```
+
+---
+
+### 📝 Auto-Update Your `.env.example` Template
+Stop updating `.env.example` templates manually! Run this command to automatically read your `.env` file and generate a clean `.env.example` containing only the keys (values are safely stripped):
+```bash
+envguard sync --force
+```
+
+---
+
+### 🩺 Run a Project Health Check
+To perform a structure audit of your environment file setup (making sure `.env` is inside `.gitignore` so you don't accidentally publish secrets, checking file integrity, etc.), run:
+```bash
+envguard doctor
+```
+
+---
+
+## ⚙️ Advanced Configuration (`.envguard.yaml`)
+
+You can customize how `envguard` behaves by editing your `.envguard.yaml` file. Here is an example:
+
+```yaml
+version: 1
+
+scan:
+  paths:
+    - "."
+  ignore:
+    - "node_modules"
+    - ".git"
+    - "dist"
+  languages:
+    - auto # Auto-detects JavaScript, TypeScript, Python, Go, Rust, Ruby, Dockerfiles, etc.
+
+# Define rules for validating values
+rules:
+  DATABASE_URL:
+    required: true
+    type: url
+    description: "Primary PostgreSQL database URL"
+  PORT:
+    required: false
+    type: number
+    default: "3000"
+    description: "The port the web server runs on"
+  NODE_ENV:
+    required: true
+    type: enum
+    values:
+      - development
+      - production
+      - test
+```
+
+---
+
+## 🤖 Integrate with GitHub Actions
+
+Add `envguard` to your GitHub Actions workflow to block pull requests containing invalid or incomplete configurations:
+
+```yaml
+name: Guard Environment
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - name: Install envguard
+        run: go install github.com/Vamshavardhan50/envguard@latest
+      - name: Run audit
+        run: envguard audit --ci --format github
+```
+
+---
+
+## 🙋 Frequently Asked Questions (FAQ)
+
+### Does `envguard` send my secrets to a third-party server?
+**No.** `envguard` runs entirely on your local machine. It does not send any telemetry, analytics, or credentials over the internet.
+
+### What languages does the code scanner support?
+`envguard` scans JavaScript (`process.env.VAR`), TypeScript, React/Vue (`import.meta.env.VAR` or `process.env.VAR`), Python (`os.environ`), Go (`os.Getenv`), Ruby, Rust, PHP, Java, Shell scripts, and Dockerfiles out-of-the-box.
+
+### How is this different from other dotenv validators?
+Unlike most tools, `envguard` does not just check if a `.env` file exists. It **statically scans your source code files** to find what keys your code actually references, highlighting code references that are completely missing from your config.
+
+---
+
+## 📄 License
+This project is open-source software licensed under the [MIT License](LICENSE).

envguard_bin-1.0.3/README.md

@@ -0,0 +1,183 @@
+# envguard 🛡️
+
+[![CI](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml)
+[![Release](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Think of `envguard` as a spell-checker/linter for your environment variables.** 
+> It scans your code, checks your `.env` files, and makes sure you never break your app in production due to a missing or misconfigured setting. It is fast, works 100% offline, and requires zero configuration to start.
+
+---
+
+## What is envguard?
+Have you ever deployed an app, only for it to immediately crash because you forgot to copy a new API key to the server? Or because someone configured `PORT` as a word instead of a number?
+
+`envguard` solves this by automatically finding all environment variables your code uses (like `process.env.DATABASE_URL` or `os.environ.get('PORT')`) and checking them against your `.env` configuration file. It warns you immediately about:
+- ❌ **Missing variables** that your code expects but are not configured.
+- ⚠️ **Unused variables** in `.env` that your code doesn't actually use.
+- 🚫 **Invalid formats** (e.g. database URLs that are not valid URLs, or ports that are not numbers).
+
+---
+
+## ⚡ Quick 1-Minute Start
+
+Get up and running in three simple steps:
+
+### 1. Install it
+Run the install command for your favorite package manager:
+
+```bash
+# Using Node (NPM)
+npm install -g envguard-bin
+
+# Using Python (PIP)
+pip install envguard
+
+# Using Go
+go install github.com/Vamshavardhan50/envguard@latest
+```
+
+### 2. Set it up
+Run the setup wizard in your project folder. It will scan your project, find your environment variables, and create a safe configuration file (`.envguard.yaml`) for you:
+
+```bash
+envguard init
+```
+
+### 3. Guard your project
+Scan your project to find any discrepancies:
+
+```bash
+envguard audit
+```
+
+---
+
+## 🔒 Security & Privacy First
+
+- **100% Offline:** `envguard` never makes network requests and never uploads anything.
+- **Privacy-Engineered:** It only reads and displays the **names** of the keys (e.g. `STRIPE_API_KEY`). It **never** reads, logs, or prints the actual secret values.
+
+---
+
+## 🛠️ How to Use: Common Tasks
+
+Here is how to run `envguard`'s most common commands in your project:
+
+### 🔍 Find Missing or Unused Keys
+To check if your local `.env` file matches what your code actually uses, run:
+```bash
+envguard audit
+```
+*Tip: In your CI/CD pipelines, run `envguard audit --ci` to automatically fail build pipelines if keys are missing.*
+
+---
+
+### 🛡️ Check If Values Are Correct (Validation)
+You can define rules in `.envguard.yaml` (e.g., checking if `DATABASE_URL` is a valid URL, or `PORT` is a number). To validate your current configuration against these rules, run:
+```bash
+envguard validate
+```
+
+---
+
+### 📝 Auto-Update Your `.env.example` Template
+Stop updating `.env.example` templates manually! Run this command to automatically read your `.env` file and generate a clean `.env.example` containing only the keys (values are safely stripped):
+```bash
+envguard sync --force
+```
+
+---
+
+### 🩺 Run a Project Health Check
+To perform a structure audit of your environment file setup (making sure `.env` is inside `.gitignore` so you don't accidentally publish secrets, checking file integrity, etc.), run:
+```bash
+envguard doctor
+```
+
+---
+
+## ⚙️ Advanced Configuration (`.envguard.yaml`)
+
+You can customize how `envguard` behaves by editing your `.envguard.yaml` file. Here is an example:
+
+```yaml
+version: 1
+
+scan:
+  paths:
+    - "."
+  ignore:
+    - "node_modules"
+    - ".git"
+    - "dist"
+  languages:
+    - auto # Auto-detects JavaScript, TypeScript, Python, Go, Rust, Ruby, Dockerfiles, etc.
+
+# Define rules for validating values
+rules:
+  DATABASE_URL:
+    required: true
+    type: url
+    description: "Primary PostgreSQL database URL"
+  PORT:
+    required: false
+    type: number
+    default: "3000"
+    description: "The port the web server runs on"
+  NODE_ENV:
+    required: true
+    type: enum
+    values:
+      - development
+      - production
+      - test
+```
+
+---
+
+## 🤖 Integrate with GitHub Actions
+
+Add `envguard` to your GitHub Actions workflow to block pull requests containing invalid or incomplete configurations:
+
+```yaml
+name: Guard Environment
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - name: Install envguard
+        run: go install github.com/Vamshavardhan50/envguard@latest
+      - name: Run audit
+        run: envguard audit --ci --format github
+```
+
+---
+
+## 🙋 Frequently Asked Questions (FAQ)
+
+### Does `envguard` send my secrets to a third-party server?
+**No.** `envguard` runs entirely on your local machine. It does not send any telemetry, analytics, or credentials over the internet.
+
+### What languages does the code scanner support?
+`envguard` scans JavaScript (`process.env.VAR`), TypeScript, React/Vue (`import.meta.env.VAR` or `process.env.VAR`), Python (`os.environ`), Go (`os.Getenv`), Ruby, Rust, PHP, Java, Shell scripts, and Dockerfiles out-of-the-box.
+
+### How is this different from other dotenv validators?
+Unlike most tools, `envguard` does not just check if a `.env` file exists. It **statically scans your source code files** to find what keys your code actually references, highlighting code references that are completely missing from your config.
+
+---
+
+## 📄 License
+This project is open-source software licensed under the [MIT License](LICENSE).

envguard_bin-1.0.3/envguard/__init__.py

@@ -0,0 +1,2 @@
+# distributions/pip/envguard/__init__.py
+# envguard python package marker.

envguard_bin-1.0.3/envguard/main.py

@@ -0,0 +1,99 @@
+# distributions/pip/envguard/main.py
+# Python wrapper for envguard that downloads the native binary on first run and executes it.
+
+import os
+import sys
+import platform
+import urllib.request
+import tarfile
+import zipfile
+import subprocess
+
+VERSION = "1.0.3"
+OWNER = "Vamshavardhan50"
+REPO = "envguard"
+
+def get_platform_details():
+    system = platform.system().lower()
+    machine = platform.machine().lower()
+
+    if system == "darwin":
+        os_name = "darwin"
+    elif system == "linux":
+        os_name = "linux"
+    elif system == "windows":
+        os_name = "windows"
+    else:
+        raise OSError(f"Unsupported operating system: {system}")
+
+    if machine in ["amd64", "x86_64"]:
+        arch_name = "amd64"
+    elif machine in ["arm64", "aarch64"]:
+        arch_name = "arm64"
+    elif machine in ["386", "i386", "i686"]:
+        arch_name = "386"
+    else:
+        raise OSError(f"Unsupported architecture: {machine}")
+
+    # goreleaser ignores windows arm64 and darwin 386
+    if os_name == "windows" and arch_name == "arm64":
+        raise OSError("envguard binary is not built for Windows ARM64")
+    if os_name == "darwin" and arch_name == "386":
+        raise OSError("envguard binary is not built for macOS 386")
+
+    return os_name, arch_name
+
+def download_binary(dest_dir, os_name, arch_name):
+    ext = "zip" if os_name == "windows" else "tar.gz"
+    archive_name = f"envguard_{os_name}_{arch_name}.{ext}"
+    url = f"https://github.com/{OWNER}/{REPO}/releases/download/v{VERSION}/{archive_name}"
+    archive_path = os.path.join(dest_dir, archive_name)
+
+    print(f"Downloading envguard v{VERSION} from {url}...")
+    try:
+        urllib.request.urlretrieve(url, archive_path)
+    except Exception as e:
+        print(f"Failed to download envguard release: {e}", file=sys.stderr)
+        raise
+
+    print("Extracting archive...")
+    try:
+        if ext == "zip":
+            with zipfile.ZipFile(archive_path, 'r') as zip_ref:
+                zip_ref.extractall(dest_dir)
+        else:
+            with tarfile.open(archive_path, 'r:gz') as tar_ref:
+                tar_ref.extractall(dest_dir)
+    except Exception as e:
+        print(f"Failed to extract envguard archive: {e}", file=sys.stderr)
+        raise
+    finally:
+        if os.path.exists(archive_path):
+            os.remove(archive_path)
+
+    binary_name = "envguard.exe" if os_name == "windows" else "envguard"
+    binary_path = os.path.join(dest_dir, binary_name)
+    if os_name != "windows" and os.path.exists(binary_path):
+        os.chmod(binary_path, 0o755)
+
+    print("envguard installation complete.")
+
+def run():
+    current_dir = os.path.dirname(os.path.abspath(__file__))
+    os_name, arch_name = get_platform_details()
+    binary_name = "envguard.exe" if os_name == "windows" else "envguard"
+    binary_path = os.path.join(current_dir, binary_name)
+
+    if not os.path.exists(binary_path):
+        download_binary(current_dir, os_name, arch_name)
+
+    args = sys.argv[1:]
+    try:
+        res = subprocess.run([binary_path] + args)
+        sys.exit(res.returncode)
+    except Exception as e:
+        print(f"Failed to execute envguard: {e}", file=sys.stderr)
+        sys.exit(2)
+
+if __name__ == "__main__":
+    run()

envguard_bin-1.0.3/envguard_bin.egg-info/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: envguard-bin
+Version: 1.0.3
+Summary: The ESLint for environment variables
+Author: Vamshavardhan50
+License: MIT
+Project-URL: Homepage, https://github.com/Vamshavardhan50/envguard
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# envguard 🛡️
+
+[![CI](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/ci.yml)
+[![Release](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml/badge.svg)](https://github.com/Vamshavardhan50/envguard/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Think of `envguard` as a spell-checker/linter for your environment variables.** 
+> It scans your code, checks your `.env` files, and makes sure you never break your app in production due to a missing or misconfigured setting. It is fast, works 100% offline, and requires zero configuration to start.
+
+---
+
+## What is envguard?
+Have you ever deployed an app, only for it to immediately crash because you forgot to copy a new API key to the server? Or because someone configured `PORT` as a word instead of a number?
+
+`envguard` solves this by automatically finding all environment variables your code uses (like `process.env.DATABASE_URL` or `os.environ.get('PORT')`) and checking them against your `.env` configuration file. It warns you immediately about:
+- ❌ **Missing variables** that your code expects but are not configured.
+- ⚠️ **Unused variables** in `.env` that your code doesn't actually use.
+- 🚫 **Invalid formats** (e.g. database URLs that are not valid URLs, or ports that are not numbers).
+
+---
+
+## ⚡ Quick 1-Minute Start
+
+Get up and running in three simple steps:
+
+### 1. Install it
+Run the install command for your favorite package manager:
+
+```bash
+# Using Node (NPM)
+npm install -g envguard-bin
+
+# Using Python (PIP)
+pip install envguard
+
+# Using Go
+go install github.com/Vamshavardhan50/envguard@latest
+```
+
+### 2. Set it up
+Run the setup wizard in your project folder. It will scan your project, find your environment variables, and create a safe configuration file (`.envguard.yaml`) for you:
+
+```bash
+envguard init
+```
+
+### 3. Guard your project
+Scan your project to find any discrepancies:
+
+```bash
+envguard audit
+```
+
+---
+
+## 🔒 Security & Privacy First
+
+- **100% Offline:** `envguard` never makes network requests and never uploads anything.
+- **Privacy-Engineered:** It only reads and displays the **names** of the keys (e.g. `STRIPE_API_KEY`). It **never** reads, logs, or prints the actual secret values.
+
+---
+
+## 🛠️ How to Use: Common Tasks
+
+Here is how to run `envguard`'s most common commands in your project:
+
+### 🔍 Find Missing or Unused Keys
+To check if your local `.env` file matches what your code actually uses, run:
+```bash
+envguard audit
+```
+*Tip: In your CI/CD pipelines, run `envguard audit --ci` to automatically fail build pipelines if keys are missing.*
+
+---
+
+### 🛡️ Check If Values Are Correct (Validation)
+You can define rules in `.envguard.yaml` (e.g., checking if `DATABASE_URL` is a valid URL, or `PORT` is a number). To validate your current configuration against these rules, run:
+```bash
+envguard validate
+```
+
+---
+
+### 📝 Auto-Update Your `.env.example` Template
+Stop updating `.env.example` templates manually! Run this command to automatically read your `.env` file and generate a clean `.env.example` containing only the keys (values are safely stripped):
+```bash
+envguard sync --force
+```
+
+---
+
+### 🩺 Run a Project Health Check
+To perform a structure audit of your environment file setup (making sure `.env` is inside `.gitignore` so you don't accidentally publish secrets, checking file integrity, etc.), run:
+```bash
+envguard doctor
+```
+
+---
+
+## ⚙️ Advanced Configuration (`.envguard.yaml`)
+
+You can customize how `envguard` behaves by editing your `.envguard.yaml` file. Here is an example:
+
+```yaml
+version: 1
+
+scan:
+  paths:
+    - "."
+  ignore:
+    - "node_modules"
+    - ".git"
+    - "dist"
+  languages:
+    - auto # Auto-detects JavaScript, TypeScript, Python, Go, Rust, Ruby, Dockerfiles, etc.
+
+# Define rules for validating values
+rules:
+  DATABASE_URL:
+    required: true
+    type: url
+    description: "Primary PostgreSQL database URL"
+  PORT:
+    required: false
+    type: number
+    default: "3000"
+    description: "The port the web server runs on"
+  NODE_ENV:
+    required: true
+    type: enum
+    values:
+      - development
+      - production
+      - test
+```
+
+---
+
+## 🤖 Integrate with GitHub Actions
+
+Add `envguard` to your GitHub Actions workflow to block pull requests containing invalid or incomplete configurations:
+
+```yaml
+name: Guard Environment
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - name: Install envguard
+        run: go install github.com/Vamshavardhan50/envguard@latest
+      - name: Run audit
+        run: envguard audit --ci --format github
+```
+
+---
+
+## 🙋 Frequently Asked Questions (FAQ)
+
+### Does `envguard` send my secrets to a third-party server?
+**No.** `envguard` runs entirely on your local machine. It does not send any telemetry, analytics, or credentials over the internet.
+
+### What languages does the code scanner support?
+`envguard` scans JavaScript (`process.env.VAR`), TypeScript, React/Vue (`import.meta.env.VAR` or `process.env.VAR`), Python (`os.environ`), Go (`os.Getenv`), Ruby, Rust, PHP, Java, Shell scripts, and Dockerfiles out-of-the-box.
+
+### How is this different from other dotenv validators?
+Unlike most tools, `envguard` does not just check if a `.env` file exists. It **statically scans your source code files** to find what keys your code actually references, highlighting code references that are completely missing from your config.
+
+---
+
+## 📄 License
+This project is open-source software licensed under the [MIT License](LICENSE).

envguard_bin-1.0.3/envguard_bin.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+envguard/__init__.py
+envguard/main.py
+envguard_bin.egg-info/PKG-INFO
+envguard_bin.egg-info/SOURCES.txt
+envguard_bin.egg-info/dependency_links.txt
+envguard_bin.egg-info/entry_points.txt
+envguard_bin.egg-info/top_level.txt

envguard_bin-1.0.3/envguard_bin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

envguard_bin-1.0.3/envguard_bin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+envguard = envguard.main:run

envguard_bin-1.0.3/envguard_bin.egg-info/top_level.txt

@@ -0,0 +1 @@
+envguard

envguard_bin-1.0.3/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "envguard-bin"
+version = "1.0.3"
+description = "The ESLint for environment variables"
+readme = "README.md"
+requires-python = ">=3.7"
+license = {text = "MIT"}
+authors = [
+    {name = "Vamshavardhan50"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/Vamshavardhan50/envguard"
+
+[project.scripts]
+envguard = "envguard.main:run"

envguard_bin-1.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+