expit 1.0.6__tar.gz → 1.0.8__tar.gz

{expit-1.0.6/src/expit.egg-info → expit-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: expit
-Version: 1.0.6
+Version: 1.0.8
 Summary: The expit function.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
@@ -24,9 +24,12 @@ License: The MIT License (MIT)
         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/expit/
+Project-URL: Documentation, https://pypi.org/project/expit
 Project-URL: Download, https://pypi.org/project/expit/#files
+Project-URL: Index, https://pypi.org/project/expit/
 Project-URL: Source, https://github.com/johannes-programming/expit
+Project-URL: Website, https://expit.johannes-programming.online
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -35,56 +38,10 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: click>=8.1.7
+Requires-Dist: preparse>=0.0.2
 
 =====
 expit
 =====
 
-Overview
---------
-
-The expit function.
-
-Installation
-------------
-
-To install expit, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install expit
-
-Example
--------
-
-To calculate the function value of 0.42 in the shell:
-
-.. code-block:: bash
-
-    py -m expit 0.42
-
-Or inside of a python script:
-
-.. code-block:: python
-
-    import expit
-    print(expit.function(0.42))
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/expit/>`_
-* `Download <https://pypi.org/project/expit/#files>`_
-* `Source <https://github.com/johannes-programming/expit>`_
-
-Credits
--------
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``expit``!
+Visit the website `https://expit.johannes-programming.online <https://expit.johannes-programming.online>`_ for more information.

expit-1.0.8/README.rst

@@ -0,0 +1,5 @@
+=====
+expit
+=====
+
+Visit the website `https://expit.johannes-programming.online <https://expit.johannes-programming.online>`_ for more information.

{expit-1.0.6 → expit-1.0.8}/pyproject.toml

@@ -9,6 +9,7 @@ authors = [
     { email = "johannes-programming@mailfence.com", name = "Johannes" },
 ]
 classifiers = [
+    "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -16,18 +17,21 @@ classifiers = [
 ]
 dependencies = [
     "click>=8.1.7",
+    "preparse>=0.0.2",
 ]
 description = "The expit function."
 keywords = []
 name = "expit"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.0.6"
+version = "1.0.8"
 
 [project.license]
 file = "LICENSE.txt"
 
 [project.urls]
-Documentation = "https://pypi.org/project/expit/"
+Documentation = "https://pypi.org/project/expit"
 Download = "https://pypi.org/project/expit/#files"
+Index = "https://pypi.org/project/expit/"
 Source = "https://github.com/johannes-programming/expit"
+Website = "https://expit.johannes-programming.online"

expit-1.0.8/src/expit/__init__.py

@@ -0,0 +1,5 @@
+from expit.core import *
+from expit.tests import *
+
+if __name__ == "__main__":
+    main()

expit-1.0.8/src/expit/core/__init__.py

@@ -0,0 +1,24 @@
+import math
+
+import click
+import preparse
+
+__all__ = ["function", "main"]
+
+
+def function(x: float):
+    try:
+        p = math.exp(-x)
+    except OverflowError:
+        p = float("+inf")
+    return 1 / (1 + p)
+
+
+@preparse.PreParser(posix=False).click()
+@click.command(add_help_option=False)
+@click.help_option("-h", "--help")
+@click.version_option(None, "-V", "--version")
+@click.argument("x", type=float)
+def main(x: float):
+    """applies the expit function to x"""
+    click.echo(function(x))

expit-1.0.8/src/expit/tests/__init__.py

@@ -0,0 +1,11 @@
+import unittest
+
+__all__ = ["test"]
+
+
+def test():
+    loader = unittest.TestLoader()
+    tests = loader.discover(start_dir="expit.tests")
+    runner = unittest.TextTestRunner()
+    result = runner.run(tests)
+    return result

expit-1.0.8/src/expit/tests/test_easy.py

@@ -0,0 +1,104 @@
+import math
+import sys
+import unittest
+from unittest.mock import patch
+
+from click.testing import CliRunner
+
+# Import the script's components
+from expit.core import function, main
+
+
+class TestFunction(unittest.TestCase):
+    def test_function_regular_values(self):
+        # Test regular values of x
+        self.assertAlmostEqual(function(0), 0.5)
+        self.assertAlmostEqual(function(1), 1 / (1 + math.exp(-1)), places=5)
+        self.assertAlmostEqual(function(-1), 1 / (1 + math.exp(1)), places=5)
+
+    def test_function_large_positive(self):
+        # Test large positive values of x (result should approach 1)
+        self.assertAlmostEqual(function(100), 1.0, places=5)
+        self.assertAlmostEqual(function(1000), 1.0, places=5)
+
+    def test_function_large_negative(self):
+        # Test large negative values of x (result should approach 0)
+        self.assertAlmostEqual(function(-100), 0.0, places=5)
+        self.assertAlmostEqual(function(-1000), 0.0, places=5)
+
+    def test_function_overflow(self):
+        # Test overflow values to ensure they are handled without errors
+        self.assertAlmostEqual(function(sys.float_info.max), 1.0, places=5)
+        self.assertAlmostEqual(function(-sys.float_info.max), 0.0, places=5)
+
+    def test_function_infinity(self):
+        # Test positive and negative infinity inputs
+        self.assertEqual(function(float("inf")), 1.0)
+        self.assertEqual(function(float("-inf")), 0.0)
+
+    def test_function_nan(self):
+        # Test NaN input; behavior may vary, but we can ensure it doesn't throw an error
+        result = function(float("nan"))
+        self.assertTrue(
+            math.isnan(result) or result in [0.0, 1.0]
+        )  # Depending on interpretation, could be NaN, 0, or 1
+
+
+class TestMainCommand(unittest.TestCase):
+    def setUp(self):
+        # Set up CliRunner for Click command-line testing
+        self.runner = CliRunner()
+
+    def test_main_help_option(self):
+        # Test help option (-h, --help) to ensure it displays usage information
+        result = self.runner.invoke(main, ["--help"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("Usage", result.output)
+        self.assertIn("applies the expit function to x", result.output)
+
+        result = self.runner.invoke(main, ["-h"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("Usage", result.output)
+        self.assertIn("applies the expit function to x", result.output)
+
+    def test_main_version_option(self):
+        # Test version option (-V, --version) to check version output
+        result = self.runner.invoke(main, ["--version"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("version", result.output.lower())
+
+        result = self.runner.invoke(main, ["-V"])
+        self.assertEqual(result.exit_code, 0)
+        self.assertIn("version", result.output.lower())
+
+    def test_main_valid_input(self):
+        # Test main function with a valid float input, checking output
+        result = self.runner.invoke(main, ["1"])
+        expected_output = f"{function(1)}\n"
+        self.assertEqual(result.exit_code, 0)
+        self.assertEqual(result.output, expected_output)
+
+        result = self.runner.invoke(main, ["--", "-1"])
+        expected_output = f"{function(-1)}\n"
+        self.assertEqual(result.exit_code, 0)
+        self.assertEqual(result.output, expected_output)
+
+    def test_main_edge_case(self):
+        # Test main function with extreme float inputs
+        result = self.runner.invoke(main, [str(sys.float_info.max)])
+        self.assertEqual(result.exit_code, 0)
+        self.assertEqual(result.output, f"{function(sys.float_info.max)}\n")
+
+        result = self.runner.invoke(main, ["--", str(-sys.float_info.max)])
+        self.assertEqual(result.exit_code, 0)
+        self.assertEqual(result.output, f"{function(-sys.float_info.max)}\n")
+
+    def test_main_invalid_input(self):
+        # Test main function with invalid input, expecting an error
+        result = self.runner.invoke(main, ["abc"])
+        self.assertNotEqual(result.exit_code, 0)
+        self.assertIn("Invalid value for 'X'", result.output)
+
+
+if __name__ == "__main__":
+    unittest.main()

{expit-1.0.6 → expit-1.0.8/src/expit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: expit
-Version: 1.0.6
+Version: 1.0.8
 Summary: The expit function.
 Author-email: Johannes <johannes-programming@mailfence.com>
 License: The MIT License (MIT)
@@ -24,9 +24,12 @@ License: The MIT License (MIT)
         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/expit/
+Project-URL: Documentation, https://pypi.org/project/expit
 Project-URL: Download, https://pypi.org/project/expit/#files
+Project-URL: Index, https://pypi.org/project/expit/
 Project-URL: Source, https://github.com/johannes-programming/expit
+Project-URL: Website, https://expit.johannes-programming.online
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -35,56 +38,10 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: click>=8.1.7
+Requires-Dist: preparse>=0.0.2
 
 =====
 expit
 =====
 
-Overview
---------
-
-The expit function.
-
-Installation
-------------
-
-To install expit, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install expit
-
-Example
--------
-
-To calculate the function value of 0.42 in the shell:
-
-.. code-block:: bash
-
-    py -m expit 0.42
-
-Or inside of a python script:
-
-.. code-block:: python
-
-    import expit
-    print(expit.function(0.42))
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/expit/>`_
-* `Download <https://pypi.org/project/expit/#files>`_
-* `Source <https://github.com/johannes-programming/expit>`_
-
-Credits
--------
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``expit``!
+Visit the website `https://expit.johannes-programming.online <https://expit.johannes-programming.online>`_ for more information.

{expit-1.0.6 → expit-1.0.8}/src/expit.egg-info/SOURCES.txt

@@ -9,4 +9,7 @@ src/expit.egg-info/PKG-INFO
 src/expit.egg-info/SOURCES.txt
 src/expit.egg-info/dependency_links.txt
 src/expit.egg-info/requires.txt
-src/expit.egg-info/top_level.txt
+src/expit.egg-info/top_level.txt
+src/expit/core/__init__.py
+src/expit/tests/__init__.py
+src/expit/tests/test_easy.py

expit-1.0.8/src/expit.egg-info/requires.txt

@@ -0,0 +1,2 @@
+click>=8.1.7
+preparse>=0.0.2

expit-1.0.6/README.rst

@@ -1,52 +0,0 @@
-=====
-expit
-=====
-
-Overview
---------
-
-The expit function.
-
-Installation
-------------
-
-To install expit, you can use ``pip``. Open your terminal and run:
-
-.. code-block:: bash
-
-    pip install expit
-
-Example
--------
-
-To calculate the function value of 0.42 in the shell:
-
-.. code-block:: bash
-
-    py -m expit 0.42
-
-Or inside of a python script:
-
-.. code-block:: python
-
-    import expit
-    print(expit.function(0.42))
-
-License
--------
-
-This project is licensed under the MIT License.
-
-Links
------
-
-* `Documentation <https://pypi.org/project/expit/>`_
-* `Download <https://pypi.org/project/expit/#files>`_
-* `Source <https://github.com/johannes-programming/expit>`_
-
-Credits
--------
-* Author: Johannes
-* Email: johannes-programming@mailfence.com
-
-Thank you for using ``expit``!

expit-1.0.6/src/expit/__init__.py

@@ -1,27 +0,0 @@
-import math as _math
-from importlib.metadata import version as _V
-
-import click as _click
-
-try:
-    __version__ = _V("expit")
-except:
-    __version__ = "UNKNOWN"
-
-
-def function(x: float):
-    try:
-        p = _math.exp(-x)
-    except OverflowError:
-        p = float("+inf")
-    return 1 / (1 + p)
-
-
-@_click.command()
-@_click.argument("x", help="the argument for the expit function")
-def main(x: float):
-    _click.echo(function(x))
-
-
-if __name__ == "__main__":
-    main()

expit-1.0.6/src/expit.egg-info/requires.txt

@@ -1 +0,0 @@
-click>=8.1.7