plotez 0.1.0__tar.gz

plotez-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Syed Ali Mohsin Bukhari
+
+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.

plotez-0.1.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: plotez
+Version: 0.1.0
+Summary: Mundane plotting done easy.
+Author-email: Syed Ali Mohsin Bukhari <ali.mohsin@ist.edu.pk>
+Project-URL: Issues, https://github.com/syedalimohsinbukhari/plotez/issues
+Project-URL: Repository, https://github.com/syedalimohsinbukhari/plotez/
+Keywords: plotting,visualization,data visualization,matplotlib,python plotting
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Dynamic: license-file
+
+# plotEZ
+
+**Mundane plotting made easy.**
+
+`plotez` is a Python library that simplifies common matplotlib plotting tasks with an intuitive API. Create complex plots
+with minimal boilerplate code.
+
+## Features
+
+- **Simple API**: Create complex plots with just a few lines of code
+- **Dual-Axis Support**: Easy creation of dual y-axis or dual x-axis plots
+- **Multi-Panel Layouts**: Flexible subplot arrangements with automatic labeling
+- **File Integration**: Direct plotting from CSV files
+- **Extensive Customization**: Full control over plot appearance via parameter classes
+- **Type Safety**: Complete type hints for better IDE support and type checking (PEP 561 compliant)
+- **Well Tested**: Comprehensive test suite with 85%+ coverage
+
+## Installation
+
+### From PyPI (once published)
+
+```bash
+pip install plotez
+```
+
+### From Source
+
+```bash
+git clone https://github.com/syedalimohsinbukhari/plotez.git
+cd plotez
+pip install -e .
+```
+
+### Development Installation
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from plotez import plot_xy
+
+# Generate data
+x = np.linspace(0, 10, 100)
+y = np.sin(x)
+
+# Create a plot with automatic labeling
+plot_xy(x, y, auto_label=True)
+```
+
+![Example1 Plot](examplesNimages/README_example1.png)
+
+## Examples
+
+### Dual Y-Axis Plot
+
+```python
+import numpy as np
+from plotez import plot_xyy
+
+x = np.linspace(0, 10, 100)
+y1 = np.sin(x)
+y2 = np.exp(x / 10)
+
+plot_xyy(
+    x, y1, y2,
+    x_label='Time',
+    y1_label='Sine',
+    y2_label='Exponential',
+    data_labels=['sin(x)', 'exp(x/10)'],
+    plot_title='Dual Y-Axis Example',
+    use_twin_x=True
+)
+```
+
+![Example2 Plot](examplesNimages/README_example2.png)
+
+### Multi-Panel Plots
+
+```python
+import numpy as np
+from plotez import n_plotter
+
+# Create 2×2 grid
+x_data = [np.linspace(0, 10, 100) for _ in range(4)]
+y_data = [
+    np.sin(x_data[0]),
+    np.cos(x_data[1]),
+    np.tan(x_data[2] / 5),
+    x_data[3]**2 / 100
+]
+
+fig, axs = n_plotter(
+    x_data, y_data,
+    n_rows=2, n_cols=2,
+    auto_label=True
+)
+```
+
+![Example3 Plot](examplesNimages/README_example3.png)
+
+### Custom Styling
+
+```python
+import numpy as np
+from plotez import plot_xy
+from plotez.backend.utilities import LinePlot
+
+x = np.linspace(0, 10, 100)
+y = np.sin(x)
+
+# Create custom line plot parameters
+line_params = LinePlot(
+    line_style=['-'],
+    line_width=[2],
+    color=['#FF5733'],
+    marker=['o'],
+    marker_size=[4]
+)
+
+plot_xy(x, y, plot_dictionary=line_params)
+```
+
+![Example4 Plot](examplesNimages/README_example4.png)
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### With Coverage Report
+
+```bash
+pytest --cov=src/plotez --cov-report=html
+```
+
+### Type Checking
+
+```bash
+mypy src/plotez
+```
+
+### Building Documentation
+
+```bash
+cd docs
+make html
+```
+
+## Project Status
+
+- Type hints are corrected throughout the codebase
+- Test suite implemented (80%+ coverage)
+- Documentation structure created
+- Development tools configured (pytest, mypy, sphinx)
+- PEP 561 compliance (py.typed marker)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License – see [LICENSE](LICENSE) file for details.
+
+## Authors
+
+- Syed Ali Mohsin Bukhari - [ali.mohsin@ist.edu.pk](mailto:ali.mohsin@ist.edu.pk)
+
+## Links
+
+- **Repository**: https://github.com/syedalimohsinbukhari/plotez
+- **Issues**: https://github.com/syedalimohsinbukhari/plotez/issues

plotez-0.1.0/README.md

@@ -0,0 +1,179 @@
+# plotEZ
+
+**Mundane plotting made easy.**
+
+`plotez` is a Python library that simplifies common matplotlib plotting tasks with an intuitive API. Create complex plots
+with minimal boilerplate code.
+
+## Features
+
+- **Simple API**: Create complex plots with just a few lines of code
+- **Dual-Axis Support**: Easy creation of dual y-axis or dual x-axis plots
+- **Multi-Panel Layouts**: Flexible subplot arrangements with automatic labeling
+- **File Integration**: Direct plotting from CSV files
+- **Extensive Customization**: Full control over plot appearance via parameter classes
+- **Type Safety**: Complete type hints for better IDE support and type checking (PEP 561 compliant)
+- **Well Tested**: Comprehensive test suite with 85%+ coverage
+
+## Installation
+
+### From PyPI (once published)
+
+```bash
+pip install plotez
+```
+
+### From Source
+
+```bash
+git clone https://github.com/syedalimohsinbukhari/plotez.git
+cd plotez
+pip install -e .
+```
+
+### Development Installation
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from plotez import plot_xy
+
+# Generate data
+x = np.linspace(0, 10, 100)
+y = np.sin(x)
+
+# Create a plot with automatic labeling
+plot_xy(x, y, auto_label=True)
+```
+
+![Example1 Plot](examplesNimages/README_example1.png)
+
+## Examples
+
+### Dual Y-Axis Plot
+
+```python
+import numpy as np
+from plotez import plot_xyy
+
+x = np.linspace(0, 10, 100)
+y1 = np.sin(x)
+y2 = np.exp(x / 10)
+
+plot_xyy(
+    x, y1, y2,
+    x_label='Time',
+    y1_label='Sine',
+    y2_label='Exponential',
+    data_labels=['sin(x)', 'exp(x/10)'],
+    plot_title='Dual Y-Axis Example',
+    use_twin_x=True
+)
+```
+
+![Example2 Plot](examplesNimages/README_example2.png)
+
+### Multi-Panel Plots
+
+```python
+import numpy as np
+from plotez import n_plotter
+
+# Create 2×2 grid
+x_data = [np.linspace(0, 10, 100) for _ in range(4)]
+y_data = [
+    np.sin(x_data[0]),
+    np.cos(x_data[1]),
+    np.tan(x_data[2] / 5),
+    x_data[3]**2 / 100
+]
+
+fig, axs = n_plotter(
+    x_data, y_data,
+    n_rows=2, n_cols=2,
+    auto_label=True
+)
+```
+
+![Example3 Plot](examplesNimages/README_example3.png)
+
+### Custom Styling
+
+```python
+import numpy as np
+from plotez import plot_xy
+from plotez.backend.utilities import LinePlot
+
+x = np.linspace(0, 10, 100)
+y = np.sin(x)
+
+# Create custom line plot parameters
+line_params = LinePlot(
+    line_style=['-'],
+    line_width=[2],
+    color=['#FF5733'],
+    marker=['o'],
+    marker_size=[4]
+)
+
+plot_xy(x, y, plot_dictionary=line_params)
+```
+
+![Example4 Plot](examplesNimages/README_example4.png)
+
+## Development
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### With Coverage Report
+
+```bash
+pytest --cov=src/plotez --cov-report=html
+```
+
+### Type Checking
+
+```bash
+mypy src/plotez
+```
+
+### Building Documentation
+
+```bash
+cd docs
+make html
+```
+
+## Project Status
+
+- Type hints are corrected throughout the codebase
+- Test suite implemented (80%+ coverage)
+- Documentation structure created
+- Development tools configured (pytest, mypy, sphinx)
+- PEP 561 compliance (py.typed marker)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License – see [LICENSE](LICENSE) file for details.
+
+## Authors
+
+- Syed Ali Mohsin Bukhari - [ali.mohsin@ist.edu.pk](mailto:ali.mohsin@ist.edu.pk)
+
+## Links
+
+- **Repository**: https://github.com/syedalimohsinbukhari/plotez
+- **Issues**: https://github.com/syedalimohsinbukhari/plotez/issues

plotez-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plotez"
+description = "Mundane plotting done easy."
+authors = [{ name = "Syed Ali Mohsin Bukhari", email = "ali.mohsin@ist.edu.pk" }]
+
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10"
+license-files = ["LICENSE"]
+dynamic = ["version"]
+dependencies = ["matplotlib"]
+keywords = ["plotting", "visualization", "data visualization", "matplotlib", "python plotting"]
+
+[tool.setuptools.dynamic]
+version = { attr = "plotez.version.__version__" }
+
+[tool.your_package.contacts]
+emails = ["ali.mohsin@ist.edu.pk", "syedali.b+github@outlook.com"]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-cov", "mypy", "sphinx", "sphinx-rtd-theme", "black"]
+
+[project.urls]
+#Homepage = "https://readthedocs.pymultifit.com"
+Issues = "https://github.com/syedalimohsinbukhari/plotez/issues"
+Repository = "https://github.com/syedalimohsinbukhari/plotez/"
+
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["examplesNimages", "examples", "*tests*"]

plotez-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

plotez-0.1.0/src/plotez/__init__.py

@@ -0,0 +1,25 @@
+"""
+PlotEZ - Mundane plotting made easy.
+
+A Python library for simplified matplotlib plotting.
+"""
+
+from .plotez import (
+    n_plotter,
+    plot_two_column_file,
+    plot_with_dual_axes,
+    plot_xy,
+    plot_xyy,
+    two_subplots,
+)
+from .version import __version__
+
+__all__ = [
+    "plot_two_column_file",
+    "plot_xy",
+    "plot_xyy",
+    "plot_with_dual_axes",
+    "two_subplots",
+    "n_plotter",
+    "__version__",
+]

plotez-0.1.0/src/plotez/backend/__init__.py

@@ -0,0 +1 @@
+"""Created on Jul 20 00:17:08 2022."""

plotez-0.1.0/src/plotez/backend/error_handling.py

@@ -0,0 +1,46 @@
+"""
+PlotEZ Error Handling.
+
+Custom exceptions for plotting operations.
+"""
+
+
+class PlotError(Exception):
+    """
+    Base class for exceptions related to plotting operations.
+
+    Notes
+    -----
+    This serves as the parent class for all plotting-related errors.
+    Specific exceptions related to plot configuration or data issues
+    should inherit from this class.
+    """
+
+    pass
+
+
+class NoXYLabels(PlotError):
+    """
+    Raised when x or y labels are missing in a plot.
+
+    Notes
+    -----
+    This error occurs when a plot is expected to have labels for both
+    the x-axis and y-axis, but one or both are missing. Proper labeling
+    is often required for clarity in visualizations.
+    """
+
+    pass
+
+
+class OrientationError(PlotError):
+    """
+    Raised when an invalid or unexpected orientation is used in a plot.
+
+    Notes
+    -----
+    This error occurs when the orientation parameter for a plot is set
+    incorrectly or does not match the expected format.
+    """
+
+    pass