Metadata-Version: 2.1
Name: scaevola
Version: 1.0.8
Summary: class with preset right handed magic methods
Author-email: Johannes <johannes-programming@mailfence.com>
License: The MIT License (MIT)
        
        Copyright (c) 2024 Johannes
        
        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.
Project-URL: Documentation, https://pypi.org/project/scaevola
Project-URL: Download, https://pypi.org/project/scaevola/#files
Project-URL: Source, https://github.com/johannes-computer/scaevola
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.txt

========
scaevola
========

Overview
--------

This project contains the ``Scaevola`` class which can be used as a baseclass to utilize its preset righthanded magic methods: ``__ge__``, ``__gt__``, ``__radd__``, ``__rand__``, ``__rdivmod__``, ``__rfloordiv__``, ``__rlshift__``, ``__rmatmul__``, ``__rmod__``, ``__rmul__``, ``__ror__``, ``__rpow__``, ``__rrshift__``, ``__rsub__``, ``__rtruediv__``, ``__rxor__``


Example
-------

The __radd__ magic method is defined as below. The others follow the same pattern.

.. code-block:: python

    def __radd__(self, other):
        return type(self)(other) + self

Installation
------------

To install ``scaevola``, you can use ``pip``. Open your terminal and run:

.. code-block:: bash

    pip install scaevola

License
-------

This project is licensed under the MIT License.

Links
-----

* `Download <https://pypi.org/project/scaevola/#files>`_
* `Source <https://github.com/johannes-programming/scaevola>`_

Credits
-------

- Author: Johannes
- Email: `johannes-programming@mailfence.com <mailto:johannes-programming@mailfence.com>`_

Thank you for using ``scaevola``!
