Metadata-Version: 2.1
Name: pyTooling
Version: 1.10.0
Summary: pyTooling is a powerful collection of arbitrary useful classes, decorators, meta-classes and exceptions.
Home-page: https://GitHub.com/pyTooling/pyTooling.*
Author: Patrick Lehmann
Author-email: Paebbels@gmail.com
License: Apache-2.0
Project-URL: Documentation, https://pyTooling.GitHub.io/pyTooling.*
Project-URL: Source Code, https://GitHub.com/pyTooling/pyTooling.*
Project-URL: Issue Tracker, https://GitHub.com/pyTooling/pyTooling.*/issues
Keywords: decorators,meta classes,exceptions,versioning,licensing,overloading,singleton,setuptools,wheel,installation,packaging
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3 :: Only
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: Development Status :: 5 - Production/Stable
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Provides-Extra: all
Requires-Dist: sphinx-autodoc-typehints (>=1.17.0) ; extra == 'all'
Requires-Dist: autoapi ; extra == 'all'
Requires-Dist: ruamel.yaml (>=0.17) ; extra == 'all'
Requires-Dist: wheel ; extra == 'all'
Requires-Dist: mypy (>=0.931) ; extra == 'all'
Requires-Dist: lxml (>=4.8) ; extra == 'all'
Requires-Dist: sphinxcontrib-mermaid (>=0.7.1) ; extra == 'all'
Requires-Dist: Coverage (>=6.3) ; extra == 'all'
Requires-Dist: pytest (>=7.0.1) ; extra == 'all'
Requires-Dist: pytest-cov (>=3.0.0) ; extra == 'all'
Requires-Dist: sphinx-fontawesome (>=0.0.6) ; extra == 'all'
Requires-Dist: pyTooling (>=1.9.5) ; extra == 'all'
Requires-Dist: sphinx (>=4.4.0) ; extra == 'all'
Provides-Extra: build
Requires-Dist: wheel ; extra == 'build'
Requires-Dist: pyTooling (>=1.9.5) ; extra == 'build'
Provides-Extra: doc
Requires-Dist: sphinx-autodoc-typehints (>=1.17.0) ; extra == 'doc'
Requires-Dist: autoapi ; extra == 'doc'
Requires-Dist: sphinxcontrib-mermaid (>=0.7.1) ; extra == 'doc'
Requires-Dist: sphinx-fontawesome (>=0.0.6) ; extra == 'doc'
Requires-Dist: pyTooling (>=1.9.5) ; extra == 'doc'
Requires-Dist: sphinx (>=4.4.0) ; extra == 'doc'
Provides-Extra: test
Requires-Dist: ruamel.yaml (>=0.17) ; extra == 'test'
Requires-Dist: mypy (>=0.931) ; extra == 'test'
Requires-Dist: lxml (>=4.8) ; extra == 'test'
Requires-Dist: Coverage (>=6.3) ; extra == 'test'
Requires-Dist: pytest (>=7.0.1) ; extra == 'test'
Requires-Dist: pytest-cov (>=3.0.0) ; extra == 'test'
Provides-Extra: yaml
Requires-Dist: ruamel.yaml (>=0.17) ; extra == 'yaml'

[![Sourcecode on GitHub](https://img.shields.io/badge/pyTooling-pyTooling-63bf7f.svg?longCache=true&style=flat-square&longCache=true&logo=GitHub)](https://GitHub.com/pyTooling/pyTooling)
[![Sourcecode License](https://img.shields.io/pypi/l/pyTooling?longCache=true&style=flat-square&logo=Apache&label=code)](LICENSE.md)
[![Documentation](https://img.shields.io/website?longCache=true&style=flat-square&label=pyTooling.github.io%2FpyTooling&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2FpyTooling.github.io%2FpyTooling%2Findex.html)](https://pyTooling.github.io/pyTooling/)
[![Documentation License](https://img.shields.io/badge/doc-CC--BY%204.0-green?longCache=true&style=flat-square&logo=CreativeCommons&logoColor=fff)](LICENSE.md)  
[![PyPI](https://img.shields.io/pypi/v/pyTooling?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)](https://pypi.org/project/pyTooling/)
![PyPI - Status](https://img.shields.io/pypi/status/pyTooling?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyTooling?longCache=true&style=flat-square&logo=PyPI&logoColor=FBE072)  
[![GitHub Workflow - Build and Test Status](https://img.shields.io/github/workflow/status/pyTooling/pyTooling/Pipeline/main?longCache=true&style=flat-square&label=Build%20and%20test&logo=GitHub%20Actions&logoColor=FFFFFF)](https://GitHub.com/pyTooling/pyTooling/actions/workflows/Pipeline.yml)
[![Libraries.io status for latest release](https://img.shields.io/librariesio/release/pypi/pyTooling?longCache=true&style=flat-square&logo=Libraries.io&logoColor=fff)](https://libraries.io/github/pyTooling/pyTooling)
[![Codacy - Quality](https://img.shields.io/codacy/grade/8dc5205ba8b24e008f2287759096e181?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/pyTooling/pyTooling)
[![Codacy - Coverage](https://img.shields.io/codacy/coverage/8dc5205ba8b24e008f2287759096e181?longCache=true&style=flat-square&logo=Codacy)](https://www.codacy.com/gh/pyTooling/pyTooling)
[![Codecov - Branch Coverage](https://img.shields.io/codecov/c/github/pyTooling/pyTooling?longCache=true&style=flat-square&logo=Codecov)](https://codecov.io/gh/pyTooling/pyTooling)

<!--
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/hdl/community)
[![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/pypi/pyTooling?longCache=true&style=flat-square&logo=GitHub)](https://github.com/pyTooling/pyTooling/network/dependents)
[![Requires.io](https://img.shields.io/requires/github/pyTooling/pyTooling?longCache=true&style=flat-square)](https://requires.io/github/pyTooling/pyTooling/requirements/?branch=main)
[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/pyTooling)](https://libraries.io/github/pyTooling/pyTooling/sourcerank)
-->

# pyTooling

**pyTooling** is a powerful collection of arbitrary useful classes, decorators,
meta-classes and exceptions. It's useful for any Python-base project independent
if it's a library, framework or CLI tool.

## Introduction

*TODO*

## Package Details

### Common Classes

* [pyTooling.CallByRef.*](https://pyTooling.GitHub.io/pyTooling/CallByRef/)  
  Emulation of *call-by-reference* parameters.
* [pyTooling.Versioning.*](https://pyTooling.GitHub.io/pyTooling/Versioning/)  
  Class representations of semantic version (SemVer) and calendar version (CalVer) numbers.


### Decorators

* [export](https://pyTooling.GitHub.io/pyTooling/Decorators/Visibility.html#export)  
  Register the given function or class as publicly accessible in a module.


### Exceptions

* [EnvironmentException](https://pyTooling.GitHub.io/pyTooling/Exceptions/PredefinedExceptions.html#environmentexception)  
  ... is raised when an expected environment variable is missing.
* [PlatformNotSupportedException](https://pyTooling.GitHub.io/pyTooling/Exceptions/PredefinedExceptions.html#platformnotsupportedexception)  
  ... is raise if the platform is not supported.
* [NotConfiguredException](https://pyTooling.GitHub.io/pyTooling/Exceptions/PredefinedExceptions.html#notconfiguredexception)  
  ... is raise if the requested setting is not configured.


### Meta-Classes

* [Singleton](https://pyTooling.GitHub.io/pyTooling/MetaClasses/Singleton.html)  
  Allow only a single instance of a class.
* [Overloading](https://pyTooling.GitHub.io/pyTooling/MetaClasses/Overloading.html)  
  Overloading Allow method overloading in Python classes. Dispatch method calls based on method signatures (type annotations).

## Examples

### `@export` Decorator

```Python
from pyTooling.Decorators import export

@export
class MyClass:
  pass
```

### `CallByRefIntParam`

```Python
from pyTooling.CallByRef import CallByRefIntParam

# define a call-by-reference parameter for integer values
myInt = CallByRefIntParam(3)

# a function using a call-by-reference parameter
def func(param: CallByRefIntParam):
  param <<= param * 4

# call the function and pass the wrapper object
func(myInt)

print(myInt.Value)
```


## Contributors

* [Patrick Lehmann](https://GitHub.com/Paebbels) (Maintainer)
* [and more...](https://GitHub.com/pyTooling/pyTooling/graphs/contributors)


## License

This Python package (source code) licensed under [Apache License 2.0](LICENSE.md).  
The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).


-------------------------

SPDX-License-Identifier: Apache-2.0


