generate-env-sample 0.0.1__tar.gz

generate_env_sample-0.0.1/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.3
+Name: generate-env-sample
+Version: 0.0.1
+Summary: Add your description here
+Author: Heshinth P
+Author-email: heshinth@gmail.com
+Requires-Dist: typer-slim>=0.17.4
+Requires-Python: >=3.11
+Project-URL: Issues, https://github.com/heshinth/generate-env-sample/issues
+Project-URL: Repository, https://github.com/heshinth/generate-env-sample.git
+Description-Content-Type: text/markdown
+
+# generate-env-sample
+
+A simple CLI tool to generate `.env.sample` files from existing `.env` files. This tool reads your `.env` file, preserves comments and empty lines, and creates a sample file with keys but without values.
+
+## Features
+
+- Preserves comments and empty lines from the original `.env` file.
+- Generates a clean `.env.sample` with keys set to empty values.
+- Built with Python and Typer.
+
+## Installation
+
+
+### Prerequisites
+- Python 3.11 or higher
+
+### Install from Source
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/heshinth/generate-env-sample.git
+   cd generate-env-sample
+   ```
+
+2. Install dependencies using `uv` (recommended):
+   ```bash
+   uv sync
+   ```
+
+   Or using pip:
+   ```bash
+   pip install -e .
+   ```
+
+## Usage
+
+Run the tool from the command line:
+
+```bash
+generate-env-sample
+```
+
+### Options
+- `--file-name`: Specify the `.env` file to read from (default: `.env`)
+- `--sample-name`: Specify the output `.env.sample` file (default: `.env.sample`)
+
+### Examples
+
+1. Generate `.env.sample` from the default `.env`:
+   ```bash
+   generate-env-sample
+   ```
+
+2. Use a custom `.env` file:
+   ```bash
+   generate-env-sample --file-name myenv.env --sample-name myenv.sample
+   ```
+
+3. Get help:
+   ```bash
+   generate-env-sample --help
+   ```
+
+## Example Input/Output
+
+Given a `.env` file like:
+```
+# Database configuration
+DB_HOST=localhost
+DB_PORT=5432
+
+# API keys
+API_KEY=your_secret_key
+```
+
+The generated `.env.sample` will be:
+```
+# Database configuration
+DB_HOST=
+DB_PORT=
+
+# API keys
+API_KEY=
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on [GitHub](https://github.com/heshinth/generate-env-sample).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

generate_env_sample-0.0.1/README.md

@@ -0,0 +1,91 @@
+# generate-env-sample
+
+A simple CLI tool to generate `.env.sample` files from existing `.env` files. This tool reads your `.env` file, preserves comments and empty lines, and creates a sample file with keys but without values.
+
+## Features
+
+- Preserves comments and empty lines from the original `.env` file.
+- Generates a clean `.env.sample` with keys set to empty values.
+- Built with Python and Typer.
+
+## Installation
+
+
+### Prerequisites
+- Python 3.11 or higher
+
+### Install from Source
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/heshinth/generate-env-sample.git
+   cd generate-env-sample
+   ```
+
+2. Install dependencies using `uv` (recommended):
+   ```bash
+   uv sync
+   ```
+
+   Or using pip:
+   ```bash
+   pip install -e .
+   ```
+
+## Usage
+
+Run the tool from the command line:
+
+```bash
+generate-env-sample
+```
+
+### Options
+- `--file-name`: Specify the `.env` file to read from (default: `.env`)
+- `--sample-name`: Specify the output `.env.sample` file (default: `.env.sample`)
+
+### Examples
+
+1. Generate `.env.sample` from the default `.env`:
+   ```bash
+   generate-env-sample
+   ```
+
+2. Use a custom `.env` file:
+   ```bash
+   generate-env-sample --file-name myenv.env --sample-name myenv.sample
+   ```
+
+3. Get help:
+   ```bash
+   generate-env-sample --help
+   ```
+
+## Example Input/Output
+
+Given a `.env` file like:
+```
+# Database configuration
+DB_HOST=localhost
+DB_PORT=5432
+
+# API keys
+API_KEY=your_secret_key
+```
+
+The generated `.env.sample` will be:
+```
+# Database configuration
+DB_HOST=
+DB_PORT=
+
+# API keys
+API_KEY=
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on [GitHub](https://github.com/heshinth/generate-env-sample).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

generate_env_sample-0.0.1/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "generate-env-sample"
+version = "0.0.1"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    {name = "Heshinth P"},
+    {email = "heshinth@gmail.com"}
+]
+
+requires-python = ">=3.11"
+dependencies = ["typer-slim>=0.17.4"]
+
+[project.urls]
+Repository = "https://github.com/heshinth/generate-env-sample.git"
+Issues = "https://github.com/heshinth/generate-env-sample/issues"
+
+
+[project.scripts]
+generate-env-sample = "generate_env_sample.main:app"
+
+[build-system]
+requires = ["uv_build>=0.8.14,<0.9.0"]
+build-backend = "uv_build"

generate_env_sample-0.0.1/src/generate_env_sample/main.py

@@ -0,0 +1,78 @@
+import typer
+from pathlib import Path
+from typing_extensions import Annotated
+
+
+app = typer.Typer(
+    add_completion=False,
+    help="A CLI tool to generate .env.sample files from .env files.",
+    invoke_without_command=True,
+)
+
+
+@app.command()
+def main(
+    file: Annotated[str, typer.Option(help="The .env file to read from")] = ".env",
+    sample: Annotated[
+        str, typer.Option(help="The .env.sample file to create")
+    ] = ".env.sample",
+) -> None:
+    """
+    Generate a .env.sample file from the existing .env file.
+    """
+
+    env_path = Path(file)
+    sample_path = Path(sample)
+
+    if not env_path.exists():
+        typer.echo(f"Error: {file} file not found.", err=True)
+        raise typer.Exit(code=1)
+
+    if sample_path.exists():
+        overwrite = typer.confirm(
+            f"File {sample} already exists. Overwrite?", default=True
+        )
+        if not overwrite:
+            typer.echo("Operation cancelled.")
+            raise typer.Exit(code=0)
+
+    try:
+        with env_path.open("r", encoding="utf-8") as env_file:
+            typer.echo(f"Generating {sample} from {file}...")
+            sample_lines = []
+
+            for line in env_file:
+                stripped = line.strip()
+                if not stripped or stripped.startswith("#"):
+                    sample_lines.append(line)  # Preserve comments and empty lines
+                elif "=" in line:
+                    key = line.split("=", 1)[0].strip()
+                    sample_lines.append(f"{key}=\n")
+                else:
+                    # Treat non-key lines as comments or skip
+                    sample_lines.append(line)
+
+            with sample_path.open("w", encoding="utf-8") as sample_file:
+                sample_file.writelines(sample_lines)
+
+            typer.echo(f"{sample} created successfully!")
+
+    except PermissionError:
+        typer.echo(
+            f"Error: Permission denied for {file} or {sample}.", err=True
+        )
+        raise typer.Exit(code=1)
+
+    except UnicodeDecodeError:
+        typer.echo(
+            f"Error: Encoding issue with {file}. Ensure it's UTF-8.", err=True
+        )
+        raise typer.Exit(code=1)
+
+    except Exception as e:
+        typer.echo(f"An unexpected error occurred: {e}", err=True)
+        raise typer.Exit(code=1)
+
+
+if __name__ == "__main__":
+    app()