envdot 1.0.0__tar.gz

envdot-1.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include requirements.txt
+recursive-include envdot *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

envdot-1.0.0/PKG-INFO

@@ -0,0 +1,331 @@
+Metadata-Version: 2.4
+Name: envdot
+Version: 1.0.0
+Summary: Enhanced environment variable management with multi-format support
+Home-page: https://github.com/cumulus13/envdot
+Author: Hadi Cahyadi
+Author-email: Hadi Cahyadi <cumulus13@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/cumulus13/envdot
+Project-URL: Documentation, https://github.com/cumulus13/envdot#readme
+Project-URL: Repository, https://github.com/cumulus13/envdot
+Project-URL: Bug Tracker, https://github.com/cumulus13/envdot/issues
+Keywords: environment,variables,config,envdot,configuration
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: yaml
+Requires-Dist: PyYAML>=5.1; extra == "yaml"
+Provides-Extra: all
+Requires-Dist: PyYAML>=5.1; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=0.950; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# envdot
+
+Enhanced environment variable management for Python with multi-format support and automatic type detection.
+
+## Features
+
+- 🔧 **Multiple Format Support**: `.env`, `.json`, `.yaml`, `.yml`, and `.ini` files
+- 🎯 **Automatic Type Detection**: Automatically converts strings to `bool`, `int`, `float`, or keeps as `string`
+- 💾 **Read and Write**: Load from and save to configuration files
+- 🔄 **Method Chaining**: Fluent API for cleaner code
+- 🌍 **OS Environment Integration**: Seamlessly works with `os.environ`
+- 📦 **Zero Dependencies**: Core functionality works without external packages (YAML support requires PyYAML)
+
+## Installation
+
+```bash
+pip install envdot
+
+# With YAML support
+pip install envdot[yaml]
+
+# With all extras
+pip install envdot[all]
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from envdot import DotEnv
+
+# Auto-detect and load from common config files (.env, config.json, etc.)
+env = DotEnv()
+
+# Or specify a file
+env = DotEnv('.env')
+
+# Get values with automatic type detection
+db_host = env.get('DB_HOST')          # Returns string
+db_port = env.get('DB_PORT')          # Returns int (auto-detected)
+debug_mode = env.get('DEBUG')         # Returns bool (auto-detected)
+api_timeout = env.get('API_TIMEOUT')  # Returns float (auto-detected)
+
+# Set values
+env.set('NEW_KEY', 'value')
+env.set('FEATURE_ENABLED', True)
+
+# Save to file
+env.save('.env')
+```
+
+### Convenience Functions
+
+```python
+from envdot import load_env, get_env, set_env, save_env
+
+# Load configuration
+load_env('.env')
+
+# Get values
+database_url = get_env('DATABASE_URL')
+max_connections = get_env('MAX_CONNECTIONS', default=100)
+
+# Set values
+set_env('NEW_FEATURE', True)
+
+# Save changes
+save_env('.env')
+```
+
+### Working with Different File Formats
+
+#### .env File
+```python
+env = DotEnv('.env')
+env.load()
+```
+
+#### JSON File
+```python
+env = DotEnv('config.json')
+env.load()
+```
+
+#### YAML File
+```python
+env = DotEnv('config.yaml')
+env.load()  # Requires PyYAML
+```
+
+#### INI File
+```python
+env = DotEnv('config.ini')
+env.load()
+```
+
+### Type Detection Examples
+
+The package automatically detects and converts types:
+
+```python
+# Given this .env file:
+# DEBUG=true
+# PORT=8080
+# TIMEOUT=30.5
+# APP_NAME=MyApp
+# EMPTY_VALUE=
+
+env = DotEnv('.env')
+
+env.get('DEBUG')      # Returns: True (bool)
+env.get('PORT')       # Returns: 8080 (int)
+env.get('TIMEOUT')    # Returns: 30.5 (float)
+env.get('APP_NAME')   # Returns: 'MyApp' (str)
+env.get('EMPTY_VALUE') # Returns: None
+```
+
+### Explicit Type Casting
+
+```python
+# Force a specific type
+version = env.get('VERSION', cast_type=str)
+port = env.get('PORT', cast_type=int)
+enabled = env.get('ENABLED', cast_type=bool)
+```
+
+### Method Chaining
+
+```python
+env = DotEnv('.env') \
+    .load() \
+    .set('NEW_KEY', 'value') \
+    .set('ANOTHER_KEY', 123) \
+    .save()
+```
+
+### Dictionary-Style Access
+
+```python
+env = DotEnv('.env')
+
+# Get values
+value = env['KEY_NAME']
+
+# Set values
+env['NEW_KEY'] = 'new value'
+
+# Check existence
+if 'API_KEY' in env:
+    print("API key is configured")
+
+# Get all variables
+all_vars = env.all()
+```
+
+### Advanced Features
+
+#### Load Without Overriding
+
+```python
+env.load(override=False)  # Keep existing values
+```
+
+#### Load Without Applying to OS Environment
+
+```python
+env.load(apply_to_os=False)  # Don't set in os.environ
+```
+
+#### Save to Different Format
+
+```python
+env = DotEnv('.env')
+env.load()
+env.save('config.json')  # Convert .env to JSON
+```
+
+#### Clear Variables
+
+```python
+env.clear()  # Clear internal storage only
+env.clear(clear_os=True)  # Also clear from os.environ
+```
+
+#### Delete Specific Keys
+
+```python
+env.delete('OLD_KEY')
+env.delete('TEMP_KEY', remove_from_os=True)
+```
+
+## Type Detection Rules
+
+The package uses the following rules for automatic type detection:
+
+- **Boolean**: `true`, `yes`, `on`, `1` → `True` | `false`, `no`, `off`, `0` → `False`
+- **None**: `none`, `null`, empty string → `None`
+- **Integer**: Numbers without decimal point → `int`
+- **Float**: Numbers with decimal point → `float`
+- **String**: Everything else → `str`
+
+## File Format Examples
+
+### .env
+```env
+DEBUG=true
+PORT=8080
+DATABASE_URL=postgresql://localhost/mydb
+```
+
+### .json
+```json
+{
+  "DEBUG": true,
+  "PORT": 8080,
+  "DATABASE_URL": "postgresql://localhost/mydb"
+}
+```
+
+### .yaml
+```yaml
+DEBUG: true
+PORT: 8080
+DATABASE_URL: postgresql://localhost/mydb
+```
+
+### .ini
+```ini
+[DEFAULT]
+DEBUG = true
+PORT = 8080
+DATABASE_URL = postgresql://localhost/mydb
+```
+
+## API Reference
+
+### DotEnv Class
+
+#### `__init__(filepath=None, auto_load=True)`
+Initialize DotEnv instance.
+
+#### `load(filepath=None, override=True, apply_to_os=True)`
+Load environment variables from file.
+
+#### `get(key, default=None, cast_type=None)`
+Get environment variable with automatic type detection.
+
+#### `set(key, value, apply_to_os=True)`
+Set environment variable.
+
+#### `save(filepath=None, format=None)`
+Save environment variables to file.
+
+#### `delete(key, remove_from_os=True)`
+Delete environment variable.
+
+#### `all()`
+Get all environment variables as dictionary.
+
+#### `keys()`
+Get all variable names.
+
+#### `clear(clear_os=False)`
+Clear all stored variables.
+
+### Convenience Functions
+
+- `load_env(filepath=None, **kwargs)` - Load environment variables
+- `get_env(key, default=None, cast_type=None)` - Get environment variable
+- `set_env(key, value, **kwargs)` - Set environment variable
+- `save_env(filepath=None, **kwargs)` - Save environment variables
+
+## License
+
+MIT License
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+
+## Author
+[Hadi Cahyadi](mailto:cumulus13@gmail.com)
+    
+
+[![Buy Me a Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/cumulus13)
+
+[![Donate via Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cumulus13)
+
+[Support me on Patreon](https://www.patreon.com/cumulus13)

envdot-1.0.0/README.md

@@ -0,0 +1,291 @@
+# envdot
+
+Enhanced environment variable management for Python with multi-format support and automatic type detection.
+
+## Features
+
+- 🔧 **Multiple Format Support**: `.env`, `.json`, `.yaml`, `.yml`, and `.ini` files
+- 🎯 **Automatic Type Detection**: Automatically converts strings to `bool`, `int`, `float`, or keeps as `string`
+- 💾 **Read and Write**: Load from and save to configuration files
+- 🔄 **Method Chaining**: Fluent API for cleaner code
+- 🌍 **OS Environment Integration**: Seamlessly works with `os.environ`
+- 📦 **Zero Dependencies**: Core functionality works without external packages (YAML support requires PyYAML)
+
+## Installation
+
+```bash
+pip install envdot
+
+# With YAML support
+pip install envdot[yaml]
+
+# With all extras
+pip install envdot[all]
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from envdot import DotEnv
+
+# Auto-detect and load from common config files (.env, config.json, etc.)
+env = DotEnv()
+
+# Or specify a file
+env = DotEnv('.env')
+
+# Get values with automatic type detection
+db_host = env.get('DB_HOST')          # Returns string
+db_port = env.get('DB_PORT')          # Returns int (auto-detected)
+debug_mode = env.get('DEBUG')         # Returns bool (auto-detected)
+api_timeout = env.get('API_TIMEOUT')  # Returns float (auto-detected)
+
+# Set values
+env.set('NEW_KEY', 'value')
+env.set('FEATURE_ENABLED', True)
+
+# Save to file
+env.save('.env')
+```
+
+### Convenience Functions
+
+```python
+from envdot import load_env, get_env, set_env, save_env
+
+# Load configuration
+load_env('.env')
+
+# Get values
+database_url = get_env('DATABASE_URL')
+max_connections = get_env('MAX_CONNECTIONS', default=100)
+
+# Set values
+set_env('NEW_FEATURE', True)
+
+# Save changes
+save_env('.env')
+```
+
+### Working with Different File Formats
+
+#### .env File
+```python
+env = DotEnv('.env')
+env.load()
+```
+
+#### JSON File
+```python
+env = DotEnv('config.json')
+env.load()
+```
+
+#### YAML File
+```python
+env = DotEnv('config.yaml')
+env.load()  # Requires PyYAML
+```
+
+#### INI File
+```python
+env = DotEnv('config.ini')
+env.load()
+```
+
+### Type Detection Examples
+
+The package automatically detects and converts types:
+
+```python
+# Given this .env file:
+# DEBUG=true
+# PORT=8080
+# TIMEOUT=30.5
+# APP_NAME=MyApp
+# EMPTY_VALUE=
+
+env = DotEnv('.env')
+
+env.get('DEBUG')      # Returns: True (bool)
+env.get('PORT')       # Returns: 8080 (int)
+env.get('TIMEOUT')    # Returns: 30.5 (float)
+env.get('APP_NAME')   # Returns: 'MyApp' (str)
+env.get('EMPTY_VALUE') # Returns: None
+```
+
+### Explicit Type Casting
+
+```python
+# Force a specific type
+version = env.get('VERSION', cast_type=str)
+port = env.get('PORT', cast_type=int)
+enabled = env.get('ENABLED', cast_type=bool)
+```
+
+### Method Chaining
+
+```python
+env = DotEnv('.env') \
+    .load() \
+    .set('NEW_KEY', 'value') \
+    .set('ANOTHER_KEY', 123) \
+    .save()
+```
+
+### Dictionary-Style Access
+
+```python
+env = DotEnv('.env')
+
+# Get values
+value = env['KEY_NAME']
+
+# Set values
+env['NEW_KEY'] = 'new value'
+
+# Check existence
+if 'API_KEY' in env:
+    print("API key is configured")
+
+# Get all variables
+all_vars = env.all()
+```
+
+### Advanced Features
+
+#### Load Without Overriding
+
+```python
+env.load(override=False)  # Keep existing values
+```
+
+#### Load Without Applying to OS Environment
+
+```python
+env.load(apply_to_os=False)  # Don't set in os.environ
+```
+
+#### Save to Different Format
+
+```python
+env = DotEnv('.env')
+env.load()
+env.save('config.json')  # Convert .env to JSON
+```
+
+#### Clear Variables
+
+```python
+env.clear()  # Clear internal storage only
+env.clear(clear_os=True)  # Also clear from os.environ
+```
+
+#### Delete Specific Keys
+
+```python
+env.delete('OLD_KEY')
+env.delete('TEMP_KEY', remove_from_os=True)
+```
+
+## Type Detection Rules
+
+The package uses the following rules for automatic type detection:
+
+- **Boolean**: `true`, `yes`, `on`, `1` → `True` | `false`, `no`, `off`, `0` → `False`
+- **None**: `none`, `null`, empty string → `None`
+- **Integer**: Numbers without decimal point → `int`
+- **Float**: Numbers with decimal point → `float`
+- **String**: Everything else → `str`
+
+## File Format Examples
+
+### .env
+```env
+DEBUG=true
+PORT=8080
+DATABASE_URL=postgresql://localhost/mydb
+```
+
+### .json
+```json
+{
+  "DEBUG": true,
+  "PORT": 8080,
+  "DATABASE_URL": "postgresql://localhost/mydb"
+}
+```
+
+### .yaml
+```yaml
+DEBUG: true
+PORT: 8080
+DATABASE_URL: postgresql://localhost/mydb
+```
+
+### .ini
+```ini
+[DEFAULT]
+DEBUG = true
+PORT = 8080
+DATABASE_URL = postgresql://localhost/mydb
+```
+
+## API Reference
+
+### DotEnv Class
+
+#### `__init__(filepath=None, auto_load=True)`
+Initialize DotEnv instance.
+
+#### `load(filepath=None, override=True, apply_to_os=True)`
+Load environment variables from file.
+
+#### `get(key, default=None, cast_type=None)`
+Get environment variable with automatic type detection.
+
+#### `set(key, value, apply_to_os=True)`
+Set environment variable.
+
+#### `save(filepath=None, format=None)`
+Save environment variables to file.
+
+#### `delete(key, remove_from_os=True)`
+Delete environment variable.
+
+#### `all()`
+Get all environment variables as dictionary.
+
+#### `keys()`
+Get all variable names.
+
+#### `clear(clear_os=False)`
+Clear all stored variables.
+
+### Convenience Functions
+
+- `load_env(filepath=None, **kwargs)` - Load environment variables
+- `get_env(key, default=None, cast_type=None)` - Get environment variable
+- `set_env(key, value, **kwargs)` - Set environment variable
+- `save_env(filepath=None, **kwargs)` - Save environment variables
+
+## License
+
+MIT License
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+
+## Author
+[Hadi Cahyadi](mailto:cumulus13@gmail.com)
+    
+
+[![Buy Me a Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/cumulus13)
+
+[![Donate via Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cumulus13)
+
+[Support me on Patreon](https://www.patreon.com/cumulus13)

envdot-1.0.0/envdot/__init__.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# file: envdot/__init__.py
+# Author: Hadi Cahyadi <cumulus13@gmail.com>
+# Date: 2025-10-10 23:59:34.906959
+# License: MIT
+
+"""
+envdot: Enhanced environment variable management with multi-format support
+Supports .env, .json, .yaml, .yml, and .ini files with automatic type detection
+"""
+
+from .core import DotEnv, load_env, get_env, set_env, save_env
+from .exceptions import DotEnvError, FileNotFoundError, ParseError, TypeConversionError
+
+__version__ = "1.0.0"
+__all__ = [
+    "DotEnv",
+    "load_env",
+    "get_env",
+    "set_env",
+    "save_env",
+    "DotEnvError",
+    "FileNotFoundError",
+    "ParseError",
+    "TypeConversionError"
+]