wry 0.1.9.dev2__tar.gz → 0.2.0__tar.gz

{wry-0.1.9.dev2/wry.egg-info → wry-0.2.0}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.1.9.dev2
+Version: 0.2.0
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
-Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
-Project-URL: Homepage, https://github.com/tahouse/wry
-Project-URL: Repository, https://github.com/tahouse/wry
-Project-URL: Issues, https://github.com/tahouse/wry/issues
-Project-URL: Documentation, https://github.com/tahouse/wry#readme
+License-File: LICENSE
 Keywords: cli,pydantic,click,wry,dry,configuration,type-safe
+Author: Tyler House
+Author-email: 26489166+tahouse@users.noreply.github.com
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 1 - Planning
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -16,33 +15,19 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: System :: System Shells
 Classifier: Topic :: Utilities
-Requires-Python: >=3.10
+Requires-Dist: annotated-types (>=0.6.0,<0.7.0)
+Requires-Dist: click (>=8.0,<9.0)
+Requires-Dist: pydantic (>=2.9.2,<3.0.0)
+Requires-Dist: pydantic-core (>=2.23.4,<3.0.0)
+Project-URL: Documentation, https://github.com/tahouse/wry#readme
+Project-URL: Homepage, https://github.com/tahouse/wry
+Project-URL: Repository, https://github.com/tahouse/wry
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: click>=8.0
-Requires-Dist: pydantic>=2.9.2
-Requires-Dist: annotated-types>=0.5.0
-Requires-Dist: pydantic-core>=2.23.4
-Provides-Extra: dev
-Requires-Dist: pytest>=6.0; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy>=1.17.1; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: setuptools-scm>=8.0; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: safety; extra == "dev"
-Requires-Dist: bandit[toml]; extra == "dev"
-Provides-Extra: test
-Requires-Dist: pytest>=6.0; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-xdist; extra == "test"
-Dynamic: license-file
 
 # wry - Why Repeat Yourself? CLI
 
@@ -81,7 +66,7 @@ The simplest way to use wry is with `AutoWryModel`, which automatically generate
 ```python
 import click
 from pydantic import Field
-from wry import AutoWryModel, generate_click_parameters
+from wry import AutoWryModel
 
 class AppArgs(AutoWryModel):
     """Configuration for my app."""
@@ -91,9 +76,10 @@ class AppArgs(AutoWryModel):
     verbose: bool = Field(default=False, description="Verbose output")
 
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 def main(**kwargs):
     """My simple CLI application."""
+    # Create the model instance from kwargs
     config = AppArgs(**kwargs)
     click.echo(f"Hello {config.name}, you are {config.age} years old!")
 
@@ -101,6 +87,8 @@ if __name__ == "__main__":
     main()
 ```
 
+**Note**: Currently, `generate_click_parameters()` passes individual parameters as kwargs to your function. You need to instantiate the model yourself. See the [Future Features](#future-features) section for a potential cleaner API.
+
 Run it:
 
 ```bash
@@ -122,7 +110,7 @@ wry can track where each configuration value came from. You have two options:
 
 ```python
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 def main(**kwargs):
     # Simple instantiation - no source tracking
     config = AppArgs(**kwargs)
@@ -133,7 +121,7 @@ def main(**kwargs):
 
 ```python
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 @click.pass_context
 def main(ctx, **kwargs):
     # Full source tracking with context
@@ -210,7 +198,7 @@ Use multiple Pydantic models in a single command:
 ```python
 from typing import Annotated
 import click
-from wry import WryModel, AutoOption, generate_click_parameters, multi_model
+from wry import WryModel, AutoOption, multi_model, create_models
 
 class ServerConfig(WryModel):
     host: Annotated[str, AutoOption] = "localhost"
@@ -222,7 +210,13 @@ class DatabaseArgs(WryModel):
 
 @click.command()
 @multi_model(ServerConfig, DatabaseConfig)
-def serve(server: ServerConfig, database: DatabaseConfig):
+@click.pass_context
+def serve(ctx, **kwargs):
+    # Create model instances
+    configs = create_models(ctx, kwargs, ServerConfig, DatabaseConfig)
+    server = configs[ServerConfig]
+    database = configs[DatabaseConfig]
+
     print(f"Starting server at {server.host}:{server.port}")
     print(f"Database: {database.db_url} (pool size: {database.pool_size})")
 ```
@@ -233,7 +227,7 @@ Automatically generate options for all fields:
 
 ```python
 import click
-from wry import AutoWryModel, generate_click_parameters
+from wry import AutoWryModel
 from pydantic import Field
 
 class QuickConfig(AutoWryModel):
@@ -244,7 +238,7 @@ class QuickConfig(AutoWryModel):
     email: str = Field(description="Your email")
 
 @click.command()
-@generate_click_parameters(QuickConfig)
+@QuickConfig.generate_click_parameters()
 def quickstart(config: QuickConfig):
     print(f"Hello {config.name}!")
 ```
@@ -307,8 +301,8 @@ By default, `generate_click_parameters` runs in strict mode to prevent common mi
 
 ```python
 @click.command()
-@generate_click_parameters(Config)  # strict=True by default
-@generate_click_parameters(Config)  # ERROR: Duplicate decorator detected!
+@Config.generate_click_parameters()  # strict=True by default
+@Config.generate_click_parameters()  # ERROR: Duplicate decorator detected!
 def main(**kwargs):
     pass
 ```
@@ -316,7 +310,7 @@ def main(**kwargs):
 To allow multiple decorators (not recommended):
 
 ```python
-@generate_click_parameters(Config, strict=False)
+@Config.generate_click_parameters(strict=False)
 ```
 
 ### Manual Field Control
@@ -369,11 +363,14 @@ cd wry
 python -m venv venv
 source venv/bin/activate  # On Windows: venv\Scripts\activate
 
-# Install in development mode
-pip install -e ".[dev,test]"
+# Install Poetry (if not already installed)
+pip install poetry
+
+# Install all dependencies in development mode
+poetry install
 
 # Install pre-commit hooks
-pre-commit install
+poetry run pre-commit install
 ```
 
 ### Running Tests
@@ -434,7 +431,8 @@ To ensure consistent behavior between local development and CI:
 Install the exact versions used in CI:
 
 ```bash
-pip install -e ".[dev,test]" --upgrade
+poetry update
+poetry install
 ```
 
 ### Coverage Requirements
@@ -517,6 +515,46 @@ The wry codebase is organized into focused modules:
 
 We welcome contributions! Please follow these guidelines to ensure a smooth process.
 
+### Development Setup
+
+We use Poetry for dependency management to ensure consistent environments:
+
+```bash
+# Install Poetry (if not already installed)
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies (including dev dependencies)
+poetry install
+
+# Activate the virtual environment
+poetry shell
+```
+
+**Important**: Poetry automatically creates an isolated virtual environment and uses `poetry.lock` to ensure everyone has the exact same dependencies.
+
+### Common Poetry Commands
+
+```bash
+# Install dependencies from lock file
+poetry install
+
+# Update dependencies within version constraints
+poetry update
+
+# Add a new dependency
+poetry add package-name
+
+# Add a development dependency
+poetry add --group dev package-name
+
+# Show installed packages
+poetry show
+
+# Run commands in the Poetry environment
+poetry run python script.py
+poetry run pytest
+```
+
 ### Getting Started
 
 1. **Fork the repository** on GitHub
@@ -544,10 +582,9 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 1. **Set up development environment**:
 
    ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   pip install -e ".[dev,test]"
-   pre-commit install
+   poetry install        # Creates venv and installs all dependencies
+   poetry shell          # Activate the virtual environment
+   poetry run pre-commit install  # Set up git hooks
    ```
 
 2. **Make your changes**:
@@ -560,13 +597,13 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 
    ```bash
    # Run tests
-   pytest
+   poetry run pytest
 
    # Check coverage (must be 100%)
-   pytest --cov=wry --cov-report=term-missing
+   poetry run pytest --cov=wry --cov-report=term-missing
 
    # Run linting
-   pre-commit run --all-files
+   poetry run pre-commit run --all-files
    ```
 
 4. **Commit your changes**:
@@ -642,7 +679,34 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
+## Future Features
+
+### Automatic Model Instantiation (Proof of Concept)
+
+We're exploring a cleaner API that would automatically instantiate models and pass them to your function. See `examples/auto_instantiate_poc.py` for a working proof of concept:
+
+```python
+# Potential future syntax
+@click.command()
+@AppConfig.click_command()  # or @auto_instantiate(AppConfig)
+def main(config: AppConfig):
+    """The decorator would handle instantiation automatically."""
+    click.echo(f"Hello {config.name}!")
+    # Source tracking would work automatically too!
+```
+
+This would:
+
+- Automatically handle `@click.pass_context` when needed for source tracking
+- Instantiate the model and pass it with the correct parameter name
+- Support multiple models in a single command
+- Make the API more intuitive and similar to other libraries
+
+If you're interested in this feature, please provide feedback!
+
 ## Acknowledgments
 
 - Built on top of [Click](https://click.palletsprojects.com/) and [Pydantic](https://pydantic-docs.helpmanual.io/)
 - Inspired by the DRY (Don't Repeat Yourself) principle
+We'd also like to acknowledgme `pydanclick`, which uses a similar clean syntax (no kwargs to command functions). The code for this feature will be independently written given that `wry` supports source tracking, constraint help text creation, instantiation from config files, and several other features not supported by `pydanclick`.
+

wry-0.1.9.dev2/PKG-INFO → wry-0.2.0/README.md

@@ -1,49 +1,3 @@
-Metadata-Version: 2.4
-Name: wry
-Version: 0.1.9.dev2
-Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
-Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
-License: MIT
-Project-URL: Homepage, https://github.com/tahouse/wry
-Project-URL: Repository, https://github.com/tahouse/wry
-Project-URL: Issues, https://github.com/tahouse/wry/issues
-Project-URL: Documentation, https://github.com/tahouse/wry#readme
-Keywords: cli,pydantic,click,wry,dry,configuration,type-safe
-Classifier: Development Status :: 1 - Planning
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: System :: System Shells
-Classifier: Topic :: Utilities
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: click>=8.0
-Requires-Dist: pydantic>=2.9.2
-Requires-Dist: annotated-types>=0.5.0
-Requires-Dist: pydantic-core>=2.23.4
-Provides-Extra: dev
-Requires-Dist: pytest>=6.0; extra == "dev"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: mypy>=1.17.1; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-Requires-Dist: setuptools-scm>=8.0; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: safety; extra == "dev"
-Requires-Dist: bandit[toml]; extra == "dev"
-Provides-Extra: test
-Requires-Dist: pytest>=6.0; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: pytest-xdist; extra == "test"
-Dynamic: license-file
-
 # wry - Why Repeat Yourself? CLI
 
 [![PyPI version](https://badge.fury.io/py/wry.svg)](https://badge.fury.io/py/wry)
@@ -81,7 +35,7 @@ The simplest way to use wry is with `AutoWryModel`, which automatically generate
 ```python
 import click
 from pydantic import Field
-from wry import AutoWryModel, generate_click_parameters
+from wry import AutoWryModel
 
 class AppArgs(AutoWryModel):
     """Configuration for my app."""
@@ -91,9 +45,10 @@ class AppArgs(AutoWryModel):
     verbose: bool = Field(default=False, description="Verbose output")
 
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 def main(**kwargs):
     """My simple CLI application."""
+    # Create the model instance from kwargs
     config = AppArgs(**kwargs)
     click.echo(f"Hello {config.name}, you are {config.age} years old!")
 
@@ -101,6 +56,8 @@ if __name__ == "__main__":
     main()
 ```
 
+**Note**: Currently, `generate_click_parameters()` passes individual parameters as kwargs to your function. You need to instantiate the model yourself. See the [Future Features](#future-features) section for a potential cleaner API.
+
 Run it:
 
 ```bash
@@ -122,7 +79,7 @@ wry can track where each configuration value came from. You have two options:
 
 ```python
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 def main(**kwargs):
     # Simple instantiation - no source tracking
     config = AppArgs(**kwargs)
@@ -133,7 +90,7 @@ def main(**kwargs):
 
 ```python
 @click.command()
-@generate_click_parameters(AppArgs)
+@AppArgs.generate_click_parameters()
 @click.pass_context
 def main(ctx, **kwargs):
     # Full source tracking with context
@@ -210,7 +167,7 @@ Use multiple Pydantic models in a single command:
 ```python
 from typing import Annotated
 import click
-from wry import WryModel, AutoOption, generate_click_parameters, multi_model
+from wry import WryModel, AutoOption, multi_model, create_models
 
 class ServerConfig(WryModel):
     host: Annotated[str, AutoOption] = "localhost"
@@ -222,7 +179,13 @@ class DatabaseArgs(WryModel):
 
 @click.command()
 @multi_model(ServerConfig, DatabaseConfig)
-def serve(server: ServerConfig, database: DatabaseConfig):
+@click.pass_context
+def serve(ctx, **kwargs):
+    # Create model instances
+    configs = create_models(ctx, kwargs, ServerConfig, DatabaseConfig)
+    server = configs[ServerConfig]
+    database = configs[DatabaseConfig]
+
     print(f"Starting server at {server.host}:{server.port}")
     print(f"Database: {database.db_url} (pool size: {database.pool_size})")
 ```
@@ -233,7 +196,7 @@ Automatically generate options for all fields:
 
 ```python
 import click
-from wry import AutoWryModel, generate_click_parameters
+from wry import AutoWryModel
 from pydantic import Field
 
 class QuickConfig(AutoWryModel):
@@ -244,7 +207,7 @@ class QuickConfig(AutoWryModel):
     email: str = Field(description="Your email")
 
 @click.command()
-@generate_click_parameters(QuickConfig)
+@QuickConfig.generate_click_parameters()
 def quickstart(config: QuickConfig):
     print(f"Hello {config.name}!")
 ```
@@ -307,8 +270,8 @@ By default, `generate_click_parameters` runs in strict mode to prevent common mi
 
 ```python
 @click.command()
-@generate_click_parameters(Config)  # strict=True by default
-@generate_click_parameters(Config)  # ERROR: Duplicate decorator detected!
+@Config.generate_click_parameters()  # strict=True by default
+@Config.generate_click_parameters()  # ERROR: Duplicate decorator detected!
 def main(**kwargs):
     pass
 ```
@@ -316,7 +279,7 @@ def main(**kwargs):
 To allow multiple decorators (not recommended):
 
 ```python
-@generate_click_parameters(Config, strict=False)
+@Config.generate_click_parameters(strict=False)
 ```
 
 ### Manual Field Control
@@ -369,11 +332,14 @@ cd wry
 python -m venv venv
 source venv/bin/activate  # On Windows: venv\Scripts\activate
 
-# Install in development mode
-pip install -e ".[dev,test]"
+# Install Poetry (if not already installed)
+pip install poetry
+
+# Install all dependencies in development mode
+poetry install
 
 # Install pre-commit hooks
-pre-commit install
+poetry run pre-commit install
 ```
 
 ### Running Tests
@@ -434,7 +400,8 @@ To ensure consistent behavior between local development and CI:
 Install the exact versions used in CI:
 
 ```bash
-pip install -e ".[dev,test]" --upgrade
+poetry update
+poetry install
 ```
 
 ### Coverage Requirements
@@ -517,6 +484,46 @@ The wry codebase is organized into focused modules:
 
 We welcome contributions! Please follow these guidelines to ensure a smooth process.
 
+### Development Setup
+
+We use Poetry for dependency management to ensure consistent environments:
+
+```bash
+# Install Poetry (if not already installed)
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Install dependencies (including dev dependencies)
+poetry install
+
+# Activate the virtual environment
+poetry shell
+```
+
+**Important**: Poetry automatically creates an isolated virtual environment and uses `poetry.lock` to ensure everyone has the exact same dependencies.
+
+### Common Poetry Commands
+
+```bash
+# Install dependencies from lock file
+poetry install
+
+# Update dependencies within version constraints
+poetry update
+
+# Add a new dependency
+poetry add package-name
+
+# Add a development dependency
+poetry add --group dev package-name
+
+# Show installed packages
+poetry show
+
+# Run commands in the Poetry environment
+poetry run python script.py
+poetry run pytest
+```
+
 ### Getting Started
 
 1. **Fork the repository** on GitHub
@@ -544,10 +551,9 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 1. **Set up development environment**:
 
    ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   pip install -e ".[dev,test]"
-   pre-commit install
+   poetry install        # Creates venv and installs all dependencies
+   poetry shell          # Activate the virtual environment
+   poetry run pre-commit install  # Set up git hooks
    ```
 
 2. **Make your changes**:
@@ -560,13 +566,13 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 
    ```bash
    # Run tests
-   pytest
+   poetry run pytest
 
    # Check coverage (must be 100%)
-   pytest --cov=wry --cov-report=term-missing
+   poetry run pytest --cov=wry --cov-report=term-missing
 
    # Run linting
-   pre-commit run --all-files
+   poetry run pre-commit run --all-files
    ```
 
 4. **Commit your changes**:
@@ -642,7 +648,33 @@ We welcome contributions! Please follow these guidelines to ensure a smooth proc
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
+## Future Features
+
+### Automatic Model Instantiation (Proof of Concept)
+
+We're exploring a cleaner API that would automatically instantiate models and pass them to your function. See `examples/auto_instantiate_poc.py` for a working proof of concept:
+
+```python
+# Potential future syntax
+@click.command()
+@AppConfig.click_command()  # or @auto_instantiate(AppConfig)
+def main(config: AppConfig):
+    """The decorator would handle instantiation automatically."""
+    click.echo(f"Hello {config.name}!")
+    # Source tracking would work automatically too!
+```
+
+This would:
+
+- Automatically handle `@click.pass_context` when needed for source tracking
+- Instantiate the model and pass it with the correct parameter name
+- Support multiple models in a single command
+- Make the API more intuitive and similar to other libraries
+
+If you're interested in this feature, please provide feedback!
+
 ## Acknowledgments
 
 - Built on top of [Click](https://click.palletsprojects.com/) and [Pydantic](https://pydantic-docs.helpmanual.io/)
 - Inspired by the DRY (Don't Repeat Yourself) principle
+We'd also like to acknowledgme `pydanclick`, which uses a similar clean syntax (no kwargs to command functions). The code for this feature will be independently written given that `wry` supports source tracking, constraint help text creation, instantiation from config files, and several other features not supported by `pydanclick`.