hyperfast-uv-template 0.3.1__py3-none-any.whl

hyperfast_uv_template-0.3.1.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: hyperfast-uv-template
+Version: 0.3.1
+Summary: Streamlining Python Project Development with a Comprehensive Toolset for Quality, Efficiency, and Maintainability
+Project-URL: Homepage, https://hyperfast-uv.entelecheia.ai
+Project-URL: Repository, https://github.com/entelecheia/hyperfast-uv-template
+Project-URL: Documentation, https://hyperfast-uv.entelecheia.ai
+Author-email: Young Joon Lee <entelecheia@hotmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: python
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <4.0,>=3.9
+Requires-Dist: click>=8.1.7
+Description-Content-Type: text/markdown
+
+# Hyperfast UV Template
+
+[![pypi-image]][pypi-url]
+[![version-image]][release-url]
+[![release-date-image]][release-url]
+[![license-image]][license-url]
+[![codecov][codecov-image]][codecov-url]
+
+
+<!-- Links: -->
+[codecov-image]: https://codecov.io/gh/entelecheia/hyperfast-uv-template/branch/main/graph/badge.svg?token=29NXUNQUBU
+[codecov-url]: https://codecov.io/gh/entelecheia/hyperfast-uv-template
+[pypi-image]: https://img.shields.io/pypi/v/hyperfast-uv-template
+[license-image]: https://img.shields.io/github/license/entelecheia/hyperfast-uv-template
+[license-url]: https://github.com/entelecheia/hyperfast-uv-template/blob/main/LICENSE
+[version-image]: https://img.shields.io/github/v/release/entelecheia/hyperfast-uv-template?sort=semver
+[release-date-image]: https://img.shields.io/github/release-date/entelecheia/hyperfast-uv-template
+[release-url]: https://github.com/entelecheia/hyperfast-uv-template/releases
+[jupyter-book-image]: https://jupyterbook.org/en/stable/_images/badge.svg
+
+[repo-url]: https://github.com/entelecheia/hyperfast-uv-template
+[pypi-url]: https://pypi.org/project/hyperfast-uv-template
+[docs-url]: https://hyperfast-uv.entelecheia.ai
+[changelog]: https://github.com/entelecheia/hyperfast-uv-template/blob/main/CHANGELOG.md
+[contributing guidelines]: https://github.com/entelecheia/hyperfast-uv-template/blob/main/CONTRIBUTING.md
+<!-- Links: -->
+
+Streamlining Python Project Development with a Comprehensive Toolset for Quality, Efficiency, and Maintainability
+
+- Documentation: [https://hyperfast-uv.entelecheia.ai][docs-url]
+- GitHub: [https://github.com/entelecheia/hyperfast-uv-template][repo-url]
+- PyPI: [https://pypi.org/project/hyperfast-uv-template][pypi-url]
+
+The Hyperfast UV Template is a powerful and comprehensive solution designed to accelerate the development and maintenance of high-quality Python projects. By incorporating industry best practices and automating key aspects such as dependency management, releases, code formatting, testing, and documentation, this template streamlines the entire development process. It ensures code quality through continuous integration, coverage reporting, linting, and static type-checking while providing seamless support for Conventional Commits and Semantic Versioning. With the Hyperfast UV Template, developers can efficiently create and manage Python projects, focusing on their core functionality while enjoying a robust, well-organized, and maintainable codebase.
+
+## Changelog
+
+See the [CHANGELOG] for more information.
+
+## Contributing
+
+Contributions are welcome! Please see the [contributing guidelines] for more information.
+
+## License
+
+This project is released under the [MIT License][license-url].

hyperfast_uv_template-0.3.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+hyperfastuv/__cli__.py,sha256=jAP2DK3JgElb5agAU2DyYsiQ7xhVg1TBPdktYl17fIQ,1492
+hyperfastuv/__init__.py,sha256=vRh8Isbs5cxCKuqqiM-Am2wEscIHewoHXklXMZDTpmA,705
+hyperfastuv/_version.py,sha256=hjbEfJSAOKz6wEXjlAjsV-8cTCGua0uSUoY4WcVvrKs,464
+hyperfastuv/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hyperfastuv/conf/about/hyperfastpy.yaml,sha256=9GJBZBlS7Rebe-1GBhRjXjc20vYJ6B_BcjKNMP6b64s,292
+hyperfastuv/conf/about/hyperfastuv.yaml,sha256=9GJBZBlS7Rebe-1GBhRjXjc20vYJ6B_BcjKNMP6b64s,292
+hyperfast_uv_template-0.3.1.dist-info/METADATA,sha256=2UBHpEZiZuHBS0R7QABEKTq1VbXGly8pgP9PgSuFJCM,3768
+hyperfast_uv_template-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hyperfast_uv_template-0.3.1.dist-info/entry_points.txt,sha256=Ga4852JsXBtYZTa3Z0O2d2TAA3pU4-U1-z09xk62IHI,57
+hyperfast_uv_template-0.3.1.dist-info/licenses/LICENSE,sha256=6_-z_j5TJ7bQ5RlPwAJZ0Eqo3qWC6pMDjlLjz0R4wkE,1071
+hyperfast_uv_template-0.3.1.dist-info/RECORD,,

hyperfast_uv_template-0.3.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

hyperfast_uv_template-0.3.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+hyperfastuv = hyperfastuv.__cli__:main

hyperfast_uv_template-0.3.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Young Joon Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hyperfastuv/__cli__.py

@@ -0,0 +1,52 @@
+"""Command line interface for the Hyperfast UV Template package.
+
+This module provides the command-line interface for the package, allowing users
+to interact with the package functionality through the terminal.
+
+Example:
+    To use the CLI, run the package with optional arguments:
+
+    ```bash
+    $ python -m hyperfastuv --name Alice --count 2
+    Hello, Alice!
+    This is hyperfastuv version 0.1.0.
+    Hello, Alice!
+    This is hyperfastuv version 0.1.0.
+    ```
+"""
+
+import click
+
+from hyperfastuv._version import __version__
+
+
+@click.command()
+@click.version_option(__version__)
+@click.option("--count", "-c", default=1, help="Number of greetings.")
+@click.option("--name", "-n", prompt="Your name", help="The person to greet.")
+def main(count, name):
+    """Run the main CLI function.
+
+    This function serves as the entry point for the command-line interface.
+    It prints a greeting message to the user a specified number of times.
+
+    Args:
+        count: Number of times to print the greeting message
+        name: Name of the person to greet
+
+    Example:
+        >>> main(count=2, name='Alice')
+        Hello, Alice!
+        This is hyperfastuv version 0.1.0.
+        Hello, Alice!
+        This is hyperfastuv version 0.1.0.
+    """
+    # Print a message to the user.
+    for _ in range(count):
+        click.echo(f"Hello, {name}!")
+        click.echo(f"This is hyperfastuv version {__version__}.")
+
+
+# main function for the main module
+if __name__ == "__main__":
+    main()

hyperfastuv/__init__.py

@@ -0,0 +1,28 @@
+"""Hyperfast UV Template Package.
+
+Example:
+    >>> from hyperfastuv import get_version
+    >>> version = get_version()
+    >>> print(version)
+    '0.1.0'
+"""
+
+from hyperfastuv._version import __version__
+
+
+def get_version() -> str:
+    """Get the version of the package.
+
+    This function returns the current version of the package. It's useful for
+    programmatically checking the version in your code or displaying it to users.
+
+    Returns:
+        str: The version of the package in semantic versioning format (e.g., "0.1.0")
+
+    Example:
+        >>> from hyperfastuv import get_version
+        >>> version = get_version()
+        >>> print(version)
+        '0.1.0'
+    """
+    return __version__

hyperfastuv/_version.py

@@ -0,0 +1,16 @@
+"""Version information for the Hyperfast UV Template package.
+
+This module contains the version string for the package. It follows semantic versioning
+(https://semver.org/) with the format MAJOR.MINOR.PATCH.
+
+Note:
+    This is a private module and should not be imported directly by users.
+    Use `hyperfastuv.get_version()` instead.
+
+Example:
+    >>> from hyperfastuv._version import __version__
+    >>> print(__version__)
+    '0.1.0'
+"""
+
+__version__ = "0.3.1"

hyperfastuv/conf/about/hyperfastpy.yaml

@@ -0,0 +1,6 @@
+_open_link_: True
+name: "Hyperfast UV Template"
+authors: "Young Joon Lee <entelecheia@hotmail.com>"
+description: "Streamlining Python Project Development with a Comprehensive Toolset for Quality, Efficiency, and Maintainability"
+homepage: "https://hyperfast-uv.entelecheia.ai"
+license: "MIT"

hyperfastuv/conf/about/hyperfastuv.yaml

@@ -0,0 +1,6 @@
+_open_link_: True
+name: "Hyperfast UV Template"
+authors: "Young Joon Lee <entelecheia@hotmail.com>"
+description: "Streamlining Python Project Development with a Comprehensive Toolset for Quality, Efficiency, and Maintainability"
+homepage: "https://hyperfast-uv.entelecheia.ai"
+license: "MIT"