mergeron_extra 2024.739099.2__tar.gz

mergeron_extra-2024.739099.2/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: mergeron_extra
+Version: 2024.739099.2
+Summary: Tools for users of the mergeron package.
+License: MIT
+Author: Murthy Kambhampaty
+Author-email: smk@capeconomics.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: aenum (>=3.1.15,<4.0.0)
+Requires-Dist: certifi (>=2023.11.17)
+Requires-Dist: matplotlib (>=3.8)
+Requires-Dist: numpy (>=1.26,<2)
+Requires-Dist: scipy (>=1.12)
+Requires-Dist: xlsxwriter (>=3.1)
+Description-Content-Type: text/x-rst
+
+mergeron_extra: Support package for users of `mergeron`
+=======================================================
+
+Modules potentially useful to users of the :code:`mergeron` package, but which do not implement the principal functions of the package, and are hence considered "extras"  or "external" modules. One of these modules is, in fact, repackaged here although published independently.
+
+The module :code:`mergeron_extra.proportions_tests` provides methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. This module is coded for conformance to the literature and to results from the corresponding modules in :code:`R`. Although written from scratch, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/). To access these directly:
+
+.. code-block:: python
+
+    import mergeron_extra.proportions_tests as prci
+
+Module :code:`mergeron_extra.xlsxw_helper` is useful for writing highly formatted output to spreadsheets with xlsx format. The class, :code:`mergeron_extra.xlsxw_helper.CFmt` and function, :code:`mergeron_extra.xlsxw_helper.array_to_sheet` are of particular interest, and can be accessed as :code:`xlh.CFmt` and :code:`xlh.array_to_sheet` with the following import:
+
+.. code-block:: python
+
+    import mergeron_extra.xlsxw_helper as xlh
+
+A recent version of Paul Tol's python module, :code:`tol_colors.py`, which provides high-contrast color schemes for making displays with improved visibility for individuals with color-blindness, is redistributed within this package. Other than re-formatting and type annotation, the :code:`mergeron_extra.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The :code:`tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the :code:`mergeron_extra.tol_colors` module directly:
+
+.. code-block:: python
+
+    import mergeron_extra.tol_colors as ptc
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT
+
+

mergeron_extra-2024.739099.2/README.rst

@@ -0,0 +1,39 @@
+mergeron_extra: Support package for users of `mergeron`
+=======================================================
+
+Modules potentially useful to users of the :code:`mergeron` package, but which do not implement the principal functions of the package, and are hence considered "extras"  or "external" modules. One of these modules is, in fact, repackaged here although published independently.
+
+The module :code:`mergeron_extra.proportions_tests` provides methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. This module is coded for conformance to the literature and to results from the corresponding modules in :code:`R`. Although written from scratch, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/). To access these directly:
+
+.. code-block:: python
+
+    import mergeron_extra.proportions_tests as prci
+
+Module :code:`mergeron_extra.xlsxw_helper` is useful for writing highly formatted output to spreadsheets with xlsx format. The class, :code:`mergeron_extra.xlsxw_helper.CFmt` and function, :code:`mergeron_extra.xlsxw_helper.array_to_sheet` are of particular interest, and can be accessed as :code:`xlh.CFmt` and :code:`xlh.array_to_sheet` with the following import:
+
+.. code-block:: python
+
+    import mergeron_extra.xlsxw_helper as xlh
+
+A recent version of Paul Tol's python module, :code:`tol_colors.py`, which provides high-contrast color schemes for making displays with improved visibility for individuals with color-blindness, is redistributed within this package. Other than re-formatting and type annotation, the :code:`mergeron_extra.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The :code:`tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the :code:`mergeron_extra.tol_colors` module directly:
+
+.. code-block:: python
+
+    import mergeron_extra.tol_colors as ptc
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT
+

mergeron_extra-2024.739099.2/pyproject.toml

@@ -0,0 +1,172 @@
+[tool.poetry]
+name = "mergeron_extra"
+description = "Tools for users of the mergeron package."
+authors = ["Murthy Kambhampaty <smk@capeconomics.com>"]
+license = "MIT"
+readme = "README.rst"
+version = "2024.739099.2"
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry.dependencies]
+# You may need to apply the fixes in, https://github.com/python-poetry/poetry/issues/3365
+# if poetry dependency resolution appears to hang (read the page at link to the end)
+aenum = "^3.1.15"
+matplotlib = ">=3.8"
+numpy = ">=1.26, <2"
+python = "^3.12"
+scipy = ">=1.12"
+xlsxwriter = ">=3.1"
+certifi = ">=2023.11.17"
+
+
+[tool.poetry.group.dev.dependencies]
+icecream = ">=2.1.0"
+mypy = ">=1.8"
+openpyxl = ">=3.1.2"
+pendulum = ">=3.0.0"
+ruff = ">=0.5"
+poetry-plugin-export = "^1.8.0"
+pytest = ">=8.0"
+semver = ">=3.0"
+sphinx = ">=7.2"
+sphinx-autodoc-typehints = ">=2.0.0"
+sphinx-autoapi = ">=3.0"
+sphinx-immaterial = ">=0.11"
+pipdeptree = ">=2.15.1"
+types-openpyxl = ">=3.0.0"
+google-re2 = "^1.1.20240702"
+
+[tool.ruff]
+
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    ".venv",
+]
+
+target-version = "py312"
+fix = true
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+
+[tool.ruff.lint]
+# From, https://github.com/sphinx-doc/sphinx/blob/master/pyproject.toml
+select = [
+    "E", # pycodestyle
+    "F", # Pyflakes
+    "I", # isort
+    "W", # pycodestyle
+    # plugins:
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "FURB", # refurb
+    "ICN",  # flake8-import-conventions
+    "NPY",  # NumPy-specific rules
+    "PIE",  # flake8-pie
+    "PL",   # pylint
+    "PTH",  # flake8-use-pathlib
+    "S",    # flake8-bandit
+    "SIM",  # flake8-simplify
+    "TID",  # flake8-tidy-imports
+    "TCH",  # flake8-type-checking
+    "UP",   # pyupgrade
+    "RUF",  # ruff-specific
+]
+
+ignore = [
+    # flake-8 line length
+    "E501",
+    # pycodestyle
+    'E741',
+    # flake8-bugbear
+    'B006',
+    'B023',
+    # flake8-bugbear opinionated (disabled by default in flake8)
+    'B904',
+    'B905',
+    "PLR2004", # avoid magic values
+    # flake8-type-checking
+    "TCH001", # move application import into a type-checking block
+    "TCH002", # move third-party import into a type-checking block
+    "TCH003", # move third-party import into a type-checking block
+    # Use typing.TypeAlias for now:
+    # mypy yet to implements PEP 695 type aliases;
+    # sphinx (as setup here) gives different results with TypeAlias and typing statement
+    "UP040",
+]
+isort.split-on-trailing-comma = false
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = true
+line-ending = "lf"
+preview = true
+
+[tool.mypy]
+python_version = "3.12"
+ignore_missing_imports = false
+strict = true
+
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+
+no_implicit_optional = true
+no_implicit_reexport = true
+
+allow_redefinition = true
+
+plugins = "numpy.typing.mypy_plugin"
+
+[tool.pytest.ini_options]
+log_auto_indent = 4
+minversion = "8.0"
+testpaths = ["tests"]
+addopts = ["--import-mode=importlib"]
+filterwarnings = [
+    "all",
+    "ignore::DeprecationWarning:dateutil.tz.tz",
+    "ignore::DeprecationWarning:openpyxl.packaging.core",
+]
+tmp_path_retention_policy = "failed"

mergeron_extra-2024.739099.2/src/mergeron_extra/__init__.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import numpy as np
+
+_PKG_NAME: str = Path(__file__).parent.stem
+
+VERSION = "2024.739097.4"
+
+__version__ = VERSION
+
+DATA_DIR: Path = Path.home() / _PKG_NAME
+"""
+Defines a subdirectory named for this package in the user's home path.
+
+If the subdirectory doesn't exist, it is created on package invocation.
+"""
+if not DATA_DIR.is_dir():
+    DATA_DIR.mkdir(parents=False)
+
+
+np.set_printoptions(precision=18)