plotstyle 0.1.0a1__tar.gz

plotstyle-0.1.0a1/.gitignore

@@ -0,0 +1,159 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# hatch-vcs generated
+src/plotstyle/_version.py
+
+# Distribution / packaging
+.Python
+build/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+
+# 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
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs and editors
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+*.iml
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# pyright
+.pyright/
+
+# pylint
+.pylint.d/
+
+# Ruff
+.ruff_cache/
+
+# pytype
+.pytype/
+
+# profiling
+.prof
+
+# dotenv
+.env.*
+!.env.example
+
+# logs
+*.log
+
+# local configs
+*.local
+
+# static analysis
+.cache/
+
+# coverage artifacts
+coverage/
+
+# build artifacts
+*.spec
+
+# celery beat schedule
+celerybeat-schedule
+
+# backup files
+*.bak
+*.tmp
+
+# secrets (just in case)
+secrets.json

plotstyle-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to **plotstyle** will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [PEP 440](https://peps.python.org/pep-0440/) versioning.
+
+---
+
+## [Unreleased]
+
+_Nothing yet._
+
+---
+
+## [0.1.0a1] - 2026-04-07
+
+First public alpha release.
+
+### Added
+
+- **Core style engine** — `plotstyle.use()` applies journal presets to Matplotlib's `rcParams`; works as a context manager with automatic restoration on exit.
+- **Figure helpers** — `plotstyle.figure()` and `plotstyle.subplots()` create correctly-sized figures at the exact column width and max height specified by each journal.
+- **Auto panel labels** — multi-panel figures receive **(a)**, **(b)**, **(c)**, … labels placed according to the journal's style rules.
+- **Colorblind-safe palettes** — built-in Okabe–Ito, Tol Bright, Tol Vibrant, Tol Muted, and Safe Grayscale palettes (`plotstyle.palette()`).
+- **Accessibility previews** — `plotstyle.preview_colorblind()` simulates deuteranopia, protanopia, and tritanopia; `plotstyle.preview_grayscale()` previews grayscale rendering.
+- **Pre-submission validation** — `plotstyle.validate()` checks dimensions, typography, line weights, color accessibility, and export settings against a target journal spec.
+- **Submission-ready export** — `plotstyle.savefig()` saves with font embedding and DPI enforcement; `plotstyle.export_submission()` batch-exports to all formats a journal accepts.
+- **Spec diffing & migration** — `plotstyle.diff()` compares two journal specs; `plotstyle.migrate()` re-targets a figure from one journal to another.
+- **Seaborn integration** — `patch_seaborn()` / `plotstyle_theme()` ensure PlotStyle `rcParams` survive `sns.set_theme()` calls.
+- **Gallery & print-size preview** — `plotstyle.gallery()` generates sample figures; `plotstyle.preview_print_size()` opens an interactive scaled preview window.
+- **Journal spec registry** — programmatic access via `plotstyle.registry`; specs are TOML files validated by immutable, typed dataclasses.
+- **CLI** — `plotstyle list`, `plotstyle info`, `plotstyle diff`, `plotstyle fonts`, `plotstyle validate`, and `plotstyle export` sub-commands.
+- **10 journal presets** — ACS, Cell, Elsevier, IEEE, Nature, PLOS, PRL, Science, Springer, Wiley.
+- **10 working examples** — quick start, multi-panel, palettes, accessibility, validation, export, diff/migrate, gallery, registry, context manager patterns.
+- **Dynamic versioning** — version derived from git tags via `hatch-vcs` and `importlib.metadata`.
+- **CI/CD pipeline** — GitHub Actions workflows for lint, type-check, test matrix, and automated PyPI release via OIDC Trusted Publishing.
+
+---
+
+[Unreleased]: https://github.com/rahulkaushal04/plotstyle/compare/v0.1.0a1...HEAD
+[0.1.0a1]: https://github.com/rahulkaushal04/plotstyle/releases/tag/v0.1.0a1

plotstyle-0.1.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rahul Kaushal
+
+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.

plotstyle-0.1.0a1/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: plotstyle
+Version: 0.1.0a1
+Summary: Matplotlib/seaborn style presets matching scientific journal requirements, with validation, export safety, and preview capabilities.
+Project-URL: Homepage, https://github.com/rahulkaushal04/plotstyle
+Project-URL: Documentation, https://plotstyle.readthedocs.io
+Project-URL: Repository, https://github.com/rahulkaushal04/plotstyle
+Project-URL: Issues, https://github.com/rahulkaushal04/plotstyle/issues
+Project-URL: Changelog, https://github.com/rahulkaushal04/plotstyle/blob/main/CHANGELOG.md
+Author: Rahul Kaushal
+License: MIT
+License-File: LICENSE
+Keywords: figures,journal,matplotlib,plotting,publication,scientific,seaborn,style
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: matplotlib<4,>=3.9
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: all
+Requires-Dist: fonttools<5,>=4.55; extra == 'all'
+Requires-Dist: pandas<3,>=2.2; extra == 'all'
+Requires-Dist: pillow<13,>=11.0; extra == 'all'
+Requires-Dist: seaborn<1,>=0.13.2; extra == 'all'
+Provides-Extra: color
+Requires-Dist: pillow<13,>=11.0; extra == 'color'
+Provides-Extra: dev
+Requires-Dist: mypy<2,>=1.15; extra == 'dev'
+Requires-Dist: pillow<13,>=11.0; extra == 'dev'
+Requires-Dist: pre-commit<5,>=4.0; extra == 'dev'
+Requires-Dist: pytest-cov<7,>=6.0; extra == 'dev'
+Requires-Dist: pytest-mpl<1,>=0.18; extra == 'dev'
+Requires-Dist: pytest<10,>=8.3; extra == 'dev'
+Requires-Dist: ruff<1,>=0.15; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2025.9.19; extra == 'docs'
+Requires-Dist: myst-parser<5,>=4.0; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints<4,>=3.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton<1,>=0.5; extra == 'docs'
+Requires-Dist: sphinx<10,>=9.0; extra == 'docs'
+Provides-Extra: fonttools
+Requires-Dist: fonttools<5,>=4.55; extra == 'fonttools'
+Provides-Extra: seaborn
+Requires-Dist: pandas<3,>=2.2; extra == 'seaborn'
+Requires-Dist: seaborn<1,>=0.13.2; extra == 'seaborn'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <strong>plotstyle</strong>
+</p>
+
+<p align="center">
+  <em>Publication-ready scientific figures — one line of code.</em>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/plotstyle/"><img alt="PyPI" src="https://img.shields.io/pypi/v/plotstyle?color=blue"></a>
+  <a href="https://pypi.org/project/plotstyle/"><img alt="Python" src="https://img.shields.io/pypi/pyversions/plotstyle"></a>
+  <a href="https://github.com/rahulkaushal04/plotstyle/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/rahulkaushal04/plotstyle"></a>
+  <a href="https://github.com/rahulkaushal04/plotstyle/actions"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/rahulkaushal04/plotstyle/ci.yml?label=CI"></a>
+</p>
+
+---
+
+**PlotStyle** configures [Matplotlib](https://matplotlib.org/) (and optionally [Seaborn](https://seaborn.pydata.org/)) so your figures match the typographic, dimensional, and export requirements of major scientific journals — out of the box.
+
+> **Current release:** `v0.1.0a1` (alpha)
+
+---
+
+## Table of Contents
+
+- [Features](#features)
+- [Supported Journals](#supported-journals)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [CLI](#cli)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Features
+
+- **One-line journal presets** — `plotstyle.use("nature")` sets fonts, sizes, line widths, and export parameters via Matplotlib's `rcParams`.
+- **Correctly-sized figures** — `plotstyle.figure()` / `plotstyle.subplots()` create figures at the exact column width and max height specified by each journal.
+- **Auto panel labels** — multi-panel figures get **(a)**, **(b)**, **(c)**, … labels placed according to the journal's style rules.
+- **Colorblind-safe palettes** — built-in Okabe–Ito, Tol Bright/Vibrant/Muted, and grayscale-safe palettes with optional markers and linestyles.
+- **Accessibility previews** — simulate deuteranopia, protanopia, and tritanopia; preview grayscale rendering.
+- **Pre-submission validation** — check figure dimensions, font sizes, line weights, color accessibility, and export settings against the target journal's spec.
+- **Submission-ready export** — batch-export to all formats a journal accepts (PDF, EPS, TIFF, …) with font embedding and DPI enforcement.
+- **Spec diffing & migration** — compare two journal specs side-by-side; migrate a figure from one journal to another.
+- **Seaborn compatibility** — a monkey-patch layer ensures PlotStyle's `rcParams` survive `sns.set_theme()` calls.
+- **Typed, schema-validated specs** — journal requirements are stored as TOML files validated by immutable dataclasses.
+- **CLI** — `plotstyle list`, `plotstyle info`, `plotstyle validate`, and more — no Python script needed.
+
+---
+
+## Supported Journals
+
+| Key | Journal | Publisher |
+|-----|---------|-----------|
+| `acs` | ACS (JACS) | American Chemical Society |
+| `cell` | Cell | Cell Press |
+| `elsevier` | Elsevier | Elsevier |
+| `ieee` | IEEE Transactions | IEEE |
+| `nature` | Nature | Springer Nature |
+| `plos` | PLOS ONE | Public Library of Science |
+| `prl` | Physical Review Letters | American Physical Society |
+| `science` | Science | AAAS |
+| `springer` | Springer | Springer |
+| `wiley` | Wiley | Wiley |
+
+> Need another journal? See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add one.
+
+---
+
+## Installation
+
+Requires **Python 3.10+**.
+
+```bash
+pip install plotstyle
+```
+
+### Extras
+
+```bash
+# Colorblind / grayscale preview (needs Pillow)
+pip install "plotstyle[color]"
+
+# Font subsetting / inspection
+pip install "plotstyle[fonttools]"
+
+# Seaborn integration
+pip install "plotstyle[seaborn]"
+
+# Everything
+pip install "plotstyle[all]"
+```
+
+### Development install
+
+```bash
+git clone https://github.com/rahulkaushal04/plotstyle.git
+cd plotstyle
+pip install -e ".[dev]"
+```
+
+---
+
+## Quick Start
+
+```python
+import numpy as np
+import plotstyle
+
+with plotstyle.use("nature"):
+    fig, ax = plotstyle.figure("nature", columns=1)
+
+    x = np.linspace(0, 2 * np.pi, 200)
+    ax.plot(x, np.sin(x), label="sin(x)")
+    ax.plot(x, np.cos(x), label="cos(x)")
+    ax.set_xlabel("Phase (rad)")
+    ax.set_ylabel("Amplitude (a.u.)")
+    ax.legend()
+
+    plotstyle.savefig(fig, "quickstart_nature.pdf", journal="nature")
+```
+
+`plotstyle.use()` also works as a context manager — `rcParams` are automatically restored on exit:
+
+```python
+with plotstyle.use("ieee"):
+    fig, ax = plotstyle.figure("ieee", columns=1)
+    ax.plot([1, 2, 3])
+    plotstyle.savefig(fig, "fig_ieee.eps", journal="ieee")
+# rcParams are back to normal here
+```
+
+---
+
+## Usage
+
+**Multi-panel figures** with auto labels:
+
+```python
+fig, axes = plotstyle.subplots("science", nrows=2, ncols=2, columns=2)
+# Axes get (a), (b), (c), (d) labels per journal style
+```
+
+**Colorblind-safe palettes** (Okabe–Ito, Tol Bright/Vibrant/Muted, Safe Grayscale):
+
+```python
+colors = plotstyle.palette("nature", n=4)
+styled = plotstyle.palette("ieee", n=3, with_markers=True)  # [(color, linestyle, marker), ...]
+```
+
+**Validation** — check dimensions, fonts, line weights, colors, and export settings:
+
+```python
+report = plotstyle.validate(fig, journal="nature")
+print(report.passed)    # True / False
+print(report.failures)  # with fix suggestions
+```
+
+**Submission export** — batch-export to all formats a journal accepts:
+
+```python
+plotstyle.export_submission(fig, "figure1", journal="ieee",
+                            author_surname="Kaushal",
+                            output_dir="submission_ieee")
+```
+
+**Accessibility previews**, **spec diffing & migration**, and **Seaborn integration** are also available — see the [`examples/`](examples/) directory for full usage.
+
+---
+
+## CLI
+
+```
+plotstyle list                                 # List all journal presets
+plotstyle info <journal>                       # Show spec details
+plotstyle diff <journal_a> <journal_b>         # Compare two journals
+plotstyle fonts --journal <journal>            # Check font availability
+plotstyle validate <file> --journal <journal>  # Validate a saved figure
+plotstyle export <file> --journal <journal>    # Re-export in required formats
+```
+
+---
+
+## Examples
+
+Working examples are in the [`examples/`](examples/) directory:
+
+| # | File | Topic |
+|---|------|-------|
+| 01 | [01_quickstart.py](examples/01_quickstart.py) | Basic publication-ready figure |
+| 02 | [02_multi_panel_figure.py](examples/02_multi_panel_figure.py) | 2×2 subplot grid with auto panel labels |
+| 03 | [03_color_palettes.py](examples/03_color_palettes.py) | Journal-specific and universal palettes |
+| 04 | [04_accessibility_checks.py](examples/04_accessibility_checks.py) | Colorblind and grayscale previews |
+| 05 | [05_validation.py](examples/05_validation.py) | Pre-submission validation |
+| 06 | [06_export_submission.py](examples/06_export_submission.py) | Batch submission export |
+| 07 | [07_spec_diff_and_migrate.py](examples/07_spec_diff_and_migrate.py) | Spec comparison and figure migration |
+| 08 | [08_gallery_preview.py](examples/08_gallery_preview.py) | Gallery preview generation |
+| 09 | [09_registry_and_spec.py](examples/09_registry_and_spec.py) | Registry and spec access |
+| 10 | [10_context_manager_patterns.py](examples/10_context_manager_patterns.py) | Context manager usage patterns |
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, adding journal specs, code style, and pull request guidelines.
+
+---
+
+## License
+
+[MIT](LICENSE) © 2026 Rahul Kaushal