click-extended 0.4.0__tar.gz → 1.0.0__tar.gz

{click_extended-0.4.0/click_extended.egg-info → click_extended-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 0.4.0
+Version: 1.0.0
 Summary: An extension to Click with additional features like automatic async support, aliasing and a modular decorator system.
 Author-email: Marcus Fredriksson <marcus@marcusfredriksson.com>
 License: MIT License
@@ -47,6 +47,10 @@ License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: click>=8.3.0
 Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: email-validator>=2.3.0
+Requires-Dist: python-slugify>=8.0.4
+Requires-Dist: tomli>=2.0.0; python_version < "3.11"
 Provides-Extra: build
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
@@ -59,6 +63,8 @@ Requires-Dist: pylint>=3.0.0; extra == "dev"
 Requires-Dist: isort>=5.12.0; extra == "dev"
 Requires-Dist: black>=25.9.0; extra == "dev"
 Requires-Dist: pre-commit>=4.3.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20250915; extra == "dev"
+Requires-Dist: tomli>=2.0.0; extra == "dev"
 Dynamic: license-file
 
 ![Banner](./assets/click-extended-banner.png)
@@ -88,6 +94,7 @@ An extension of the [Click](https://github.com/pallets/click) library with addit
 - **Environment Variables**: Built-in support for loading and using environment variables as a data source.
 - **Full Type Support**: Built with type-hinting from the ground up, meaning everything is fully typed.
 - **Improved Errors**: Improved error output like tips, debugging, and more.
+- **Short Flag Concatenation**: Automatically support concatenating short hand flags where `-r -f` is the same as `-rf`.
 
 ## Installation
 
@@ -116,14 +123,18 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_function()
+```
 
-# $ python cli.py "Hello world"
-# Hello world
+```bash
+$ python cli.py "Hello world"
+Hello world
+```
 
-# $ python cli.py "Hello world" --count 3
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py "Hello world" --count 3
+Hello world
+Hello world
+Hello world
 ```
 
 ### Basic Command Line Interface
@@ -146,16 +157,20 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function "Hello world"
-# Running initialization code...
-# Hello world
+```bash
+$ python cli.py my_function "Hello world"
+Running initialization code...
+Hello world
+```
 
-# $ python cli.py my_function "Hello world" --count 3
-# Running initialization code...
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py my_function "Hello world" --count 3
+Running initialization code...
+Hello world
+Hello world
+Hello world
 ```
 
 ### Using Environment Variables
@@ -181,21 +196,72 @@ def my_function_2(api_key: str):
 
 if __name__ == "__main__":
     my_group()
+```
+
+```bash
+$ python cli.py my_function_1
+The API key is: None
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_1
+The API key is: api-key
+```
+
+```bash
+$ python cli.py my_function_2
+ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_2
+The API key is: api-key
+```
+
+### Load CSV Data
+
+```python
+import pandas as pd
+from click_extended import command, argument
+from click_extended.decorators import to_path, load_csv
+
+@command()
+@argument("file", param="data")
+@to_path(extensions=["csv"], exists=True)
+@load_csv()
+def my_command(data: dict[str, Any], *args: Any, **kwargs: Any) -> None:
+    df = pd.DataFrame(data)
+    print(df.head())
+```
 
-# $ python cli.py my_function_1
-# The API key is: None
+_Note: `pandas` is not installed in this library and must be installed manually due to size._
 
-# $ API_KEY=api-key python cli.py my_function_1
-# The API key is: api-key
+### Pre-Built Children
 
-# $ python cli.py my_function_2
-# ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+This library includes a vast number of pre-built children, everything from checking values to transforming values.
 
-# $ API_KEY=api-key python cli.py my_function_2
-# The API key is: api-key
+```python
+from click_extended import command, argument, option
+from click_extended.decorators import to_snake_case, strip, is_email, minimum, dependencies
+
+@command()
+@dependencies("username", "email", "password")
+@argument("username")
+@to_snake_case()
+@strip()
+@option("email")
+@is_email()
+@option("password")
+@minimum(8)
+def create_account(username: str, email: str, password: str) -> None:
+    print("Username:", username)
+    print("Email:", email)
+    print("Password:", password)
 ```
 
-### Custom Children
+### Custom Nodes
+
+If the library does not include a decorator you need, you can easily create your own. Read more about creating your own [children](./docs/core/CHILD_NODE.md), [validators](./docs/core/VALIDATION_NODE.md), [child validators](./docs/core/CHILD_VALIDATION_NODE.md) or [parents](./docs/core/PARENT_NODE.md).
 
 ```python
 from typing import Any
@@ -205,7 +271,7 @@ from click_extended.classes import ChildNode
 from click_extended.types import Context, Decorator
 
 class MyCustomChild(ChildNode):
-    def handle_primitive(
+    def handle_string(
         self,
         value: str,
         context: Context,
@@ -236,12 +302,16 @@ def my_function(value: str):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function valid
-# The value 'VALID' should be uppercase.
+```bash
+$ python cli.py my_function valid
+The value 'VALID' should be uppercase.
+```
 
-# $ python cli.py my_function invalid
-# ValueError (my_function): "The value 'invalid' is not valid"
+```bash
+$ python cli.py my_function invalid
+ValueError (my_function): "The value 'invalid' is not valid"
 ```
 
 ## Documentation

{click_extended-0.4.0 → click_extended-1.0.0}/README.md

@@ -25,6 +25,7 @@ An extension of the [Click](https://github.com/pallets/click) library with addit
 - **Environment Variables**: Built-in support for loading and using environment variables as a data source.
 - **Full Type Support**: Built with type-hinting from the ground up, meaning everything is fully typed.
 - **Improved Errors**: Improved error output like tips, debugging, and more.
+- **Short Flag Concatenation**: Automatically support concatenating short hand flags where `-r -f` is the same as `-rf`.
 
 ## Installation
 
@@ -53,14 +54,18 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_function()
+```
 
-# $ python cli.py "Hello world"
-# Hello world
+```bash
+$ python cli.py "Hello world"
+Hello world
+```
 
-# $ python cli.py "Hello world" --count 3
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py "Hello world" --count 3
+Hello world
+Hello world
+Hello world
 ```
 
 ### Basic Command Line Interface
@@ -83,16 +88,20 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function "Hello world"
-# Running initialization code...
-# Hello world
+```bash
+$ python cli.py my_function "Hello world"
+Running initialization code...
+Hello world
+```
 
-# $ python cli.py my_function "Hello world" --count 3
-# Running initialization code...
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py my_function "Hello world" --count 3
+Running initialization code...
+Hello world
+Hello world
+Hello world
 ```
 
 ### Using Environment Variables
@@ -118,21 +127,72 @@ def my_function_2(api_key: str):
 
 if __name__ == "__main__":
     my_group()
+```
+
+```bash
+$ python cli.py my_function_1
+The API key is: None
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_1
+The API key is: api-key
+```
+
+```bash
+$ python cli.py my_function_2
+ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_2
+The API key is: api-key
+```
+
+### Load CSV Data
+
+```python
+import pandas as pd
+from click_extended import command, argument
+from click_extended.decorators import to_path, load_csv
+
+@command()
+@argument("file", param="data")
+@to_path(extensions=["csv"], exists=True)
+@load_csv()
+def my_command(data: dict[str, Any], *args: Any, **kwargs: Any) -> None:
+    df = pd.DataFrame(data)
+    print(df.head())
+```
 
-# $ python cli.py my_function_1
-# The API key is: None
+_Note: `pandas` is not installed in this library and must be installed manually due to size._
 
-# $ API_KEY=api-key python cli.py my_function_1
-# The API key is: api-key
+### Pre-Built Children
 
-# $ python cli.py my_function_2
-# ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+This library includes a vast number of pre-built children, everything from checking values to transforming values.
 
-# $ API_KEY=api-key python cli.py my_function_2
-# The API key is: api-key
+```python
+from click_extended import command, argument, option
+from click_extended.decorators import to_snake_case, strip, is_email, minimum, dependencies
+
+@command()
+@dependencies("username", "email", "password")
+@argument("username")
+@to_snake_case()
+@strip()
+@option("email")
+@is_email()
+@option("password")
+@minimum(8)
+def create_account(username: str, email: str, password: str) -> None:
+    print("Username:", username)
+    print("Email:", email)
+    print("Password:", password)
 ```
 
-### Custom Children
+### Custom Nodes
+
+If the library does not include a decorator you need, you can easily create your own. Read more about creating your own [children](./docs/core/CHILD_NODE.md), [validators](./docs/core/VALIDATION_NODE.md), [child validators](./docs/core/CHILD_VALIDATION_NODE.md) or [parents](./docs/core/PARENT_NODE.md).
 
 ```python
 from typing import Any
@@ -142,7 +202,7 @@ from click_extended.classes import ChildNode
 from click_extended.types import Context, Decorator
 
 class MyCustomChild(ChildNode):
-    def handle_primitive(
+    def handle_string(
         self,
         value: str,
         context: Context,
@@ -173,12 +233,16 @@ def my_function(value: str):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function valid
-# The value 'VALID' should be uppercase.
+```bash
+$ python cli.py my_function valid
+The value 'VALID' should be uppercase.
+```
 
-# $ python cli.py my_function invalid
-# ValueError (my_function): "The value 'invalid' is not valid"
+```bash
+$ python cli.py my_function invalid
+ValueError (my_function): "The value 'invalid' is not valid"
 ```
 
 ## Documentation

click_extended-1.0.0/click_extended/__init__.py

@@ -0,0 +1,21 @@
+"""Initialization file for the 'click_extended' module."""
+
+from click_extended.core.decorators.argument import argument
+from click_extended.core.decorators.command import command
+from click_extended.core.decorators.env import env
+from click_extended.core.decorators.group import group
+from click_extended.core.decorators.option import option
+from click_extended.core.decorators.prompt import prompt
+from click_extended.core.decorators.selection import selection
+from click_extended.core.decorators.tag import tag
+
+__all__ = [
+    "argument",
+    "command",
+    "env",
+    "group",
+    "option",
+    "prompt",
+    "selection",
+    "tag",
+]

click_extended-1.0.0/click_extended/classes.py

@@ -0,0 +1,25 @@
+"""Classes used in `click_extended`."""
+
+from click_extended.core.decorators.command import Command
+from click_extended.core.decorators.group import Group
+from click_extended.core.decorators.tag import Tag
+from click_extended.core.nodes.argument_node import ArgumentNode
+from click_extended.core.nodes.child_node import ChildNode
+from click_extended.core.nodes.child_validation_node import ChildValidationNode
+from click_extended.core.nodes.node import Node
+from click_extended.core.nodes.option_node import OptionNode
+from click_extended.core.nodes.parent_node import ParentNode
+from click_extended.core.nodes.validation_node import ValidationNode
+
+__all__ = [
+    "Node",
+    "ChildNode",
+    "ChildValidationNode",
+    "ParentNode",
+    "ArgumentNode",
+    "OptionNode",
+    "Command",
+    "Group",
+    "Tag",
+    "ValidationNode",
+]

{click_extended-0.4.0 → click_extended-1.0.0}/click_extended/types.py

@@ -2,7 +2,7 @@
 
 from typing import Any, Callable
 
-from click_extended.core.context import Context
+from click_extended.core.other.context import Context
 
 Decorator = Callable[[Callable[..., Any]], Callable[..., Any]]
 

{click_extended-0.4.0 → click_extended-1.0.0/click_extended.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_extended
-Version: 0.4.0
+Version: 1.0.0
 Summary: An extension to Click with additional features like automatic async support, aliasing and a modular decorator system.
 Author-email: Marcus Fredriksson <marcus@marcusfredriksson.com>
 License: MIT License
@@ -47,6 +47,10 @@ License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: click>=8.3.0
 Requires-Dist: python-dotenv>=1.2.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: email-validator>=2.3.0
+Requires-Dist: python-slugify>=8.0.4
+Requires-Dist: tomli>=2.0.0; python_version < "3.11"
 Provides-Extra: build
 Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
@@ -59,6 +63,8 @@ Requires-Dist: pylint>=3.0.0; extra == "dev"
 Requires-Dist: isort>=5.12.0; extra == "dev"
 Requires-Dist: black>=25.9.0; extra == "dev"
 Requires-Dist: pre-commit>=4.3.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.12.20250915; extra == "dev"
+Requires-Dist: tomli>=2.0.0; extra == "dev"
 Dynamic: license-file
 
 ![Banner](./assets/click-extended-banner.png)
@@ -88,6 +94,7 @@ An extension of the [Click](https://github.com/pallets/click) library with addit
 - **Environment Variables**: Built-in support for loading and using environment variables as a data source.
 - **Full Type Support**: Built with type-hinting from the ground up, meaning everything is fully typed.
 - **Improved Errors**: Improved error output like tips, debugging, and more.
+- **Short Flag Concatenation**: Automatically support concatenating short hand flags where `-r -f` is the same as `-rf`.
 
 ## Installation
 
@@ -116,14 +123,18 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_function()
+```
 
-# $ python cli.py "Hello world"
-# Hello world
+```bash
+$ python cli.py "Hello world"
+Hello world
+```
 
-# $ python cli.py "Hello world" --count 3
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py "Hello world" --count 3
+Hello world
+Hello world
+Hello world
 ```
 
 ### Basic Command Line Interface
@@ -146,16 +157,20 @@ def my_function(value: str, count: int):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function "Hello world"
-# Running initialization code...
-# Hello world
+```bash
+$ python cli.py my_function "Hello world"
+Running initialization code...
+Hello world
+```
 
-# $ python cli.py my_function "Hello world" --count 3
-# Running initialization code...
-# Hello world
-# Hello world
-# Hello world
+```bash
+$ python cli.py my_function "Hello world" --count 3
+Running initialization code...
+Hello world
+Hello world
+Hello world
 ```
 
 ### Using Environment Variables
@@ -181,21 +196,72 @@ def my_function_2(api_key: str):
 
 if __name__ == "__main__":
     my_group()
+```
+
+```bash
+$ python cli.py my_function_1
+The API key is: None
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_1
+The API key is: api-key
+```
+
+```bash
+$ python cli.py my_function_2
+ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+```
+
+```bash
+$ API_KEY=api-key python cli.py my_function_2
+The API key is: api-key
+```
+
+### Load CSV Data
+
+```python
+import pandas as pd
+from click_extended import command, argument
+from click_extended.decorators import to_path, load_csv
+
+@command()
+@argument("file", param="data")
+@to_path(extensions=["csv"], exists=True)
+@load_csv()
+def my_command(data: dict[str, Any], *args: Any, **kwargs: Any) -> None:
+    df = pd.DataFrame(data)
+    print(df.head())
+```
 
-# $ python cli.py my_function_1
-# The API key is: None
+_Note: `pandas` is not installed in this library and must be installed manually due to size._
 
-# $ API_KEY=api-key python cli.py my_function_1
-# The API key is: api-key
+### Pre-Built Children
 
-# $ python cli.py my_function_2
-# ProcessError (my_function_2): Required environment variable 'API_KEY' is not set.
+This library includes a vast number of pre-built children, everything from checking values to transforming values.
 
-# $ API_KEY=api-key python cli.py my_function_2
-# The API key is: api-key
+```python
+from click_extended import command, argument, option
+from click_extended.decorators import to_snake_case, strip, is_email, minimum, dependencies
+
+@command()
+@dependencies("username", "email", "password")
+@argument("username")
+@to_snake_case()
+@strip()
+@option("email")
+@is_email()
+@option("password")
+@minimum(8)
+def create_account(username: str, email: str, password: str) -> None:
+    print("Username:", username)
+    print("Email:", email)
+    print("Password:", password)
 ```
 
-### Custom Children
+### Custom Nodes
+
+If the library does not include a decorator you need, you can easily create your own. Read more about creating your own [children](./docs/core/CHILD_NODE.md), [validators](./docs/core/VALIDATION_NODE.md), [child validators](./docs/core/CHILD_VALIDATION_NODE.md) or [parents](./docs/core/PARENT_NODE.md).
 
 ```python
 from typing import Any
@@ -205,7 +271,7 @@ from click_extended.classes import ChildNode
 from click_extended.types import Context, Decorator
 
 class MyCustomChild(ChildNode):
-    def handle_primitive(
+    def handle_string(
         self,
         value: str,
         context: Context,
@@ -236,12 +302,16 @@ def my_function(value: str):
 
 if __name__ == "__main__":
     my_group()
+```
 
-# $ python cli.py my_function valid
-# The value 'VALID' should be uppercase.
+```bash
+$ python cli.py my_function valid
+The value 'VALID' should be uppercase.
+```
 
-# $ python cli.py my_function invalid
-# ValueError (my_function): "The value 'invalid' is not valid"
+```bash
+$ python cli.py my_function invalid
+ValueError (my_function): "The value 'invalid' is not valid"
 ```
 
 ## Documentation

{click_extended-0.4.0 → click_extended-1.0.0}/click_extended.egg-info/SOURCES.txt

@@ -11,14 +11,4 @@ click_extended.egg-info/SOURCES.txt
 click_extended.egg-info/dependency_links.txt
 click_extended.egg-info/requires.txt
 click_extended.egg-info/top_level.txt
-tests/test_argument_node.py
-tests/test_child_node.py
-tests/test_context.py
-tests/test_errors.py
-tests/test_lifecycle.py
-tests/test_node.py
-tests/test_option_node.py
-tests/test_parent_node.py
-tests/test_root_node.py
-tests/test_tag.py
-tests/test_tree.py
+tests/test_lifecycle.py

{click_extended-0.4.0 → click_extended-1.0.0}/click_extended.egg-info/requires.txt

@@ -1,5 +1,11 @@
 click>=8.3.0
 python-dotenv>=1.2.1
+pyyaml>=6.0.3
+email-validator>=2.3.0
+python-slugify>=8.0.4
+
+[:python_version < "3.11"]
+tomli>=2.0.0
 
 [build]
 build
@@ -14,3 +20,5 @@ pylint>=3.0.0
 isort>=5.12.0
 black>=25.9.0
 pre-commit>=4.3.0
+types-PyYAML>=6.0.12.20250915
+tomli>=2.0.0