dataplot 0.1.6__tar.gz

dataplot-0.1.6/.github/workflows/python-publish.yml

@@ -0,0 +1,46 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12.7"
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Install yaml
+        run: python -m pip install pyyaml
+      - name: Install build
+        run: python -m pip install build
+      - name: Install twine
+        run: python -m pip install twine
+      - name: Install cfgtools
+        run: python -m pip install cfgtools
+      - name: Install re-extensions
+        run: python -m pip install re-extensions
+      - name: Build package
+        run: python install.py
+      - name: Publish package
+        run: twine upload dist/* --username __token__ --password ${{ secrets.PYPI_API_TOKEN }}

dataplot-0.1.6/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

dataplot-0.1.6/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Chitaoji
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dataplot-0.1.6/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: dataplot
+Version: 0.1.6
+Summary: Provides plotting tools useful in datascience.
+Project-URL: Documentation, https://github.com/Chitaoji/dataplot/blob/main/README.md
+Project-URL: Repository, https://github.com/Chitaoji/dataplot/
+Author-email: Chitaoji <2360742040@qq.com>
+Maintainer-email: Chitaoji <2360742040@qq.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: plot
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.13
+Requires-Dist: lazyr
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: seaborn
+Requires-Dist: validating
+Description-Content-Type: text/markdown
+
+# dataplot
+Provides plotting tools useful in datascience.
+
+## Installation
+```sh
+$ pip install dataplot
+```
+
+## Requirements
+```txt
+validating
+lazyr
+matplotlib
+numpy
+pandas
+scipy
+seaborn
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/dataplot/
+
+### PyPI project
+* https://pypi.org/project/dataplot/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.1.6
+* New method `PlotDataSet.scatter()` to draw true scatter charts while keeping `PlotDataSet.plot()` as line chart behavior.
+* Improved automatic label inference for `dp.data(...)`, plotting labels, and x-axis labels in interactive contexts.
+* Plot builders now use deferred drawing; removed `dp.show()` and improved axis/figure rendering in object representations.
+* Refined rendering stability with fixes for empty-axis cleanup and figure re-rendering in `FigWrapper.__repr__`.
+* Updated minimum required Python version to >=3.13.
+
+### v0.1.5
+* Fixed issue: unworking figure settings in the artist methods.
+
+### v0.1.4
+* Fixed issue: incorrectly displayed histogram statistics when the x-label had been modified by the user.
+
+### v0.1.3
+* Allowed users to set the plot-settings by kwargs in artist methods like `PlotDataSet.hist()`, `PlotDataSet.plot()`, etc.
+* New operation methods `PlotDataSet.signedpow()` and `PlotDataSet.log10()`.
+* Renamed `PlotDataSet.signlog()` to `.signedlog()`; renamed `PlotDataSet.opclear()` to `.undo_all()`; removed `PlotDataSet.opclear_records_only()`.
+* New optional parameter `format_label=` for `PlotDataSet.set_plot()` to decide whether to format the label when painting on the axes.
+* When defining the data classes, used *dataclasses* instead of *attrs* for a faster import.
+
+### v0.1.2
+* New methods `PlotDataSet.corrmap()`, `PlotDataSet.ppplot()`, and `PlotDataSet.resample()`.
+* New optional parameter `fmt=` for `PlotDataSet.plot()`, `PlotDataSet.qqplot()`, `PlotDataSet.ppplot()`, and `PlotDataSet.ksplot()`.
+* Bugfix.
+
+### v0.1.1
+* New module-level function `dp.show()`.
+* New methods `PlotDataSet.qqplot()`, `PlotDataSet.ksplot()` and `PlotDataSet.abs()`.
+* All the plotting method (e.g., `.hist()`) will now return an `Artist` object instead of None.
+* New plot settings: `grid` and `grid_alpha`.
+* Parameters of `FigWrapper.set_figure()`, `AxesWrapper.set_axes()` and `PlotDataSet.set_plot()` are keyword-only now.
+* The returns of `.set_figure()` and `.set_axes()` will be None (instead of `self`) to avoid misunderstandings.
+* New optional parameter `inplace=` for `PlotDataSet.set_plot()` to decide whether the changes will happen in-place (which is the only option before) or in a new copy.
+* Parameter `ticks=` for `PlotDataSet.plot()` can be set to a `PlotDataSet` object now.
+
+### v0.1.0
+* `PlotDataSet` now supports binary operations including +, -, *, /, and **.
+* New methods `FigWrapper.set_figure()` and `AxesWrapper.set_axes()` - use them instead of `*.set_plot()`.
+* Simplified the usage of `AxesWrapper`.
+* New plot settings: `subplots_adjust=`, `fontdict=` and `dpi=`.
+* After this version, the required Python version is updated to >=3.11.9. Download and install v0.0.2 if the user is under lower Python version (>=3.8.13).
+
+### v0.0.2
+* Updated the meta-data.
+
+### v0.0.1
+* Initial release.

dataplot-0.1.6/README.md

@@ -0,0 +1,77 @@
+# dataplot
+Provides plotting tools useful in datascience.
+
+## Installation
+```sh
+$ pip install dataplot
+```
+
+## Requirements
+```txt
+validating
+lazyr
+matplotlib
+numpy
+pandas
+scipy
+seaborn
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/dataplot/
+
+### PyPI project
+* https://pypi.org/project/dataplot/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.1.6
+* New method `PlotDataSet.scatter()` to draw true scatter charts while keeping `PlotDataSet.plot()` as line chart behavior.
+* Improved automatic label inference for `dp.data(...)`, plotting labels, and x-axis labels in interactive contexts.
+* Plot builders now use deferred drawing; removed `dp.show()` and improved axis/figure rendering in object representations.
+* Refined rendering stability with fixes for empty-axis cleanup and figure re-rendering in `FigWrapper.__repr__`.
+* Updated minimum required Python version to >=3.13.
+
+### v0.1.5
+* Fixed issue: unworking figure settings in the artist methods.
+
+### v0.1.4
+* Fixed issue: incorrectly displayed histogram statistics when the x-label had been modified by the user.
+
+### v0.1.3
+* Allowed users to set the plot-settings by kwargs in artist methods like `PlotDataSet.hist()`, `PlotDataSet.plot()`, etc.
+* New operation methods `PlotDataSet.signedpow()` and `PlotDataSet.log10()`.
+* Renamed `PlotDataSet.signlog()` to `.signedlog()`; renamed `PlotDataSet.opclear()` to `.undo_all()`; removed `PlotDataSet.opclear_records_only()`.
+* New optional parameter `format_label=` for `PlotDataSet.set_plot()` to decide whether to format the label when painting on the axes.
+* When defining the data classes, used *dataclasses* instead of *attrs* for a faster import.
+
+### v0.1.2
+* New methods `PlotDataSet.corrmap()`, `PlotDataSet.ppplot()`, and `PlotDataSet.resample()`.
+* New optional parameter `fmt=` for `PlotDataSet.plot()`, `PlotDataSet.qqplot()`, `PlotDataSet.ppplot()`, and `PlotDataSet.ksplot()`.
+* Bugfix.
+
+### v0.1.1
+* New module-level function `dp.show()`.
+* New methods `PlotDataSet.qqplot()`, `PlotDataSet.ksplot()` and `PlotDataSet.abs()`.
+* All the plotting method (e.g., `.hist()`) will now return an `Artist` object instead of None.
+* New plot settings: `grid` and `grid_alpha`.
+* Parameters of `FigWrapper.set_figure()`, `AxesWrapper.set_axes()` and `PlotDataSet.set_plot()` are keyword-only now.
+* The returns of `.set_figure()` and `.set_axes()` will be None (instead of `self`) to avoid misunderstandings.
+* New optional parameter `inplace=` for `PlotDataSet.set_plot()` to decide whether the changes will happen in-place (which is the only option before) or in a new copy.
+* Parameter `ticks=` for `PlotDataSet.plot()` can be set to a `PlotDataSet` object now.
+
+### v0.1.0
+* `PlotDataSet` now supports binary operations including +, -, *, /, and **.
+* New methods `FigWrapper.set_figure()` and `AxesWrapper.set_axes()` - use them instead of `*.set_plot()`.
+* Simplified the usage of `AxesWrapper`.
+* New plot settings: `subplots_adjust=`, `fontdict=` and `dpi=`.
+* After this version, the required Python version is updated to >=3.11.9. Download and install v0.0.2 if the user is under lower Python version (>=3.8.13).
+
+### v0.0.2
+* Updated the meta-data.
+
+### v0.0.1
+* Initial release.

dataplot-0.1.6/examples/test.ipynb

@@ -0,0 +1,155 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Managing the working directory.\n",
+    "# NOTE: You DON'T want to change this.\n",
+    "import sys\n",
+    "from pathlib import Path\n",
+    "\n",
+    "p = Path(\"\").cwd().parent.as_posix()\n",
+    "if p not in sys.path:\n",
+    "    sys.path.append(p)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    from ..src import dataplot as dp\n",
+    "except ImportError:\n",
+    "    import src.dataplot as dp"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "\n",
+    "np.random.seed(42)\n",
+    "\n",
+    "x1 = dp.data(np.random.randn(1000))\n",
+    "x2 = dp.data(np.random.randn(1000))\n",
+    "x3 = dp.data(np.random.randn(1000))\n",
+    "x4 = dp.data(np.random.randn(1000))\n",
+    "x5 = dp.data(np.random.randn(1000))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "s = x1.join(x1 + x2, x1 + x2 + x3)\n",
+    "a0 = s.hist(title=\"Sums of i.i.d Normal Distributions\")\n",
+    "a0"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "a1 = (\n",
+    "    x1.join(x2, x3, x4, x5)\n",
+    "    .cumsum()\n",
+    "    .plot(title=\"Cummulative Sums of Random Numbers\", xlabel=\"num\", ylabel=\"value\")\n",
+    ")\n",
+    "a1"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "a2 = x1.join(x1.exp()).qqplot()\n",
+    "a2"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "noise = dp.data(\n",
+    "    (\n",
+    "        np.minimum(x1.data.max() - x1.data, x1.data - x1.data.min())\n",
+    "        / (x1.data.max() - x1.data.min())\n",
+    "    ),\n",
+    "    label=\"noise\",\n",
+    ")\n",
+    "a3 = (x1 + noise).ksplot()\n",
+    "a3"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "a4 = x1.join(x1 + x2 + x3).ppplot()\n",
+    "a4"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "sum4 = x1 + x2 + x3 + x4\n",
+    "sum5 = sum4 + x5\n",
+    "a5 = s.join(sum4, sum5).corrmap()\n",
+    "a5"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dp.figure(\n",
+    "    [a0, a1, a2, a3, a4, a5], title=\"Figure Collections\", subplots_adjust={\"top\": 0.92}\n",
+    ")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "base",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

dataplot-0.1.6/install.py

@@ -0,0 +1,100 @@
+"""Install the package."""
+
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import re
+from pathlib import Path
+from typing import Final
+
+import cfgtools as cfg
+from re_extensions import rsplit, word_wrap
+
+here = Path(__file__).parent
+
+# Load the package's meta-data from pyproject.toml.
+f = cfg.read_toml(here / "pyproject.toml")
+project = f["project"].asdict()
+NAME: Final[str] = project["name"]
+SUMMARY: Final[str] = project["description"]
+HOMEPAGE: Final[str] = project["urls"]["Repository"]
+REQUIRES: Final[list[str]] = project["dependencies"]
+SOURCE = "src"
+LICENSE = (here / project["license-files"][0]).read_text().partition("\n")[0]
+
+# Import the README and use it as the long-description.
+readme_path = here / project["readme"]
+if readme_path.exists():
+    long_description = "\n" + readme_path.read_text(encoding="utf-8")
+else:
+    long_description = SUMMARY
+
+
+def _readme2doc(
+    readme: str,
+    name: str = NAME,
+    requires: list[str] = REQUIRES,
+    homepage: str = HOMEPAGE,
+    pkg_license: str = LICENSE,
+) -> tuple[str, str]:
+    doc, rd = "", ""
+    for i, s in enumerate(rsplit("\n## ", readme)):
+        head = re.search(" .*\n", s).group()[1:-1]
+        if i == 0:
+            s = re.sub("^\n# .*", f"\n# {name}", s)
+        elif head == "Requirements":
+            s = re.sub(
+                "```txt.*```",
+                "```txt\n" + "\n".join(requires) + "\n```",
+                s,
+                flags=re.DOTALL,
+            )
+        elif head == "Installation":
+            s = re.sub(
+                "```sh.*```", f"```sh\n$ pip install {name}\n```", s, flags=re.DOTALL
+            )
+        elif head == "See Also":
+            pypipage = f"https://pypi.org/project/{name}/"
+            s = re.sub(
+                "### PyPI project\n.*",
+                f"### PyPI project\n* {pypipage}",
+                re.sub(
+                    "### Github repository\n.*",
+                    f"### Github repository\n* {homepage}",
+                    s,
+                ),
+            )
+        elif head == "License":
+            s = f"\n## License\nThis project falls under the {pkg_license}.\n"
+
+        rd += s
+        if head not in {"Installation", "Requirements", "History"}:
+            doc += s
+    doc = re.sub("<!--html-->.*<!--/html-->", "", doc, flags=re.DOTALL)
+    return word_wrap(doc, maximum=88) + "\n\n", rd
+
+
+def _quote(readme: str) -> str:
+    if "'''" in readme and '"""' in readme:
+        raise ReadmeFormatError("Both \"\"\" and ''' are found in the README")
+    if '"""' in readme:
+        return f"'''{readme}'''"
+    else:
+        return f'"""{readme}"""'
+
+
+class ReadmeFormatError(Exception):
+    """Raised when the README has a wrong format."""
+
+
+if __name__ == "__main__":
+    # Import the __init__.py and change the module docstring.
+    init_path = here / SOURCE / NAME / "__init__.py"
+    module_file = init_path.read_text(encoding="utf-8")
+    new_doc, long_description = _readme2doc(long_description)
+    module_file = re.sub(
+        "^\"\"\".*\"\"\"|^'''.*'''|^", _quote(new_doc), module_file, flags=re.DOTALL
+    )
+    init_path.write_text(module_file, encoding="utf-8")
+    readme_path.write_text(long_description.strip(), encoding="utf-8")
+    os.system(f"cd {here} && python -m build")