sane-figs 0.1.0__tar.gz

sane_figs-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jean-David T.
+
+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.

sane_figs-0.1.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: sane-figs
+Version: 0.1.0
+Summary: Publication-ready figures for Matplotlib, Seaborn, Plotly, and Altair
+Author-email: "Jean-David T." <jeandavid@example.com>
+Maintainer-email: "Jean-David T." <jeandavid@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/jeandavidt/sane-figs
+Project-URL: Documentation, https://sane-figs.readthedocs.io
+Project-URL: Repository, https://github.com/jeandavidt/sane-figs
+Project-URL: Issues, https://github.com/jeandavidt/sane-figs/issues
+Keywords: visualization,matplotlib,seaborn,plotly,altair,publication,figures,plotting,scientific,research
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: importlib-metadata; python_version < "3.8"
+Requires-Dist: Pillow>=9.0.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: matplotlib
+Requires-Dist: matplotlib>=2.0.0; extra == "matplotlib"
+Provides-Extra: seaborn
+Requires-Dist: seaborn>=0.9.0; extra == "seaborn"
+Requires-Dist: matplotlib>=2.0.0; extra == "seaborn"
+Provides-Extra: plotly
+Requires-Dist: altair>=5.4.1; extra == "plotly"
+Requires-Dist: pandas>=2.0.3; extra == "plotly"
+Requires-Dist: plotly>=4.0.0; extra == "plotly"
+Provides-Extra: altair
+Requires-Dist: altair>=3.0.0; extra == "altair"
+Provides-Extra: all
+Requires-Dist: matplotlib>=2.0.0; extra == "all"
+Requires-Dist: seaborn>=0.9.0; extra == "all"
+Requires-Dist: plotly>=4.0.0; extra == "all"
+Requires-Dist: altair>=3.0.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-regressions>=2.5.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
+Requires-Dist: packaging>=23.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-regressions>=2.5.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "test"
+Requires-Dist: packaging>=23.0.0; extra == "test"
+Requires-Dist: pandas>=1.0.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: pymdown-extensions>=10.0; extra == "docs"
+Dynamic: license-file
+
+# Sane-Figs
+
+Publication-ready figures for Matplotlib, Seaborn, Plotly, and Altair.
+
+## Overview
+
+Sane-Figs is a Python package that automatically applies publication-ready styling to figures generated with popular Python visualization libraries. It solves the common problem of figures having text that is too small for articles and presentations.
+
+## Features
+
+- **Automatic Styling**: Apply publication-ready defaults with a single function call
+- **Multiple Libraries**: Support for Matplotlib, Seaborn, Plotly, and Altair
+- **Version-Aware**: Automatically detects library versions and adapts to API changes
+- **Two Usage Modes**: Global setup or context manager for scoped styling
+- **Presets**: Built-in presets for articles and presentations
+- **Colorways**: Publication-ready color palettes (default, nature, vibrant, pastel, colorblind-safe)
+- **Watermarks**: Text and image watermark support
+
+## Installation
+
+```bash
+pip install sane-figs
+```
+
+For full library support:
+
+```bash
+pip install sane-figs[all]
+```
+
+Or install with specific libraries:
+
+```bash
+pip install sane-figs[matplotlib,seaborn]
+```
+
+## Quick Start
+
+### Global Setup
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Apply publication defaults globally
+sane_figs.setup(mode='article')
+
+# Your existing code works as-is
+plt.plot([1, 2, 3], [1, 4, 9])
+plt.title('My Figure')
+plt.xlabel('X Axis')
+plt.ylabel('Y Axis')
+plt.savefig('figure.png', dpi=300)
+```
+
+### Context Manager
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Scoped styling
+with sane_figs.publication_style(mode='article'):
+    plt.plot([1, 2, 3], [1, 4, 9])
+    plt.title('My Figure')
+    plt.savefig('figure.png')
+
+# Styling resets after context
+plt.plot([1, 2, 3], [1, 4, 9])  # Back to default styling
+```
+
+### With Colorways
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Apply colorway
+sane_figs.setup(mode='article', colorway='nature')
+
+# List available colorways
+print(sane_figs.list_colorways())
+# ['default', 'nature', 'vibrant', 'pastel', 'colorblind-safe']
+```
+
+### With Watermarks
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Text watermark
+sane_figs.setup(mode='article', watermark='© 2025 My Lab')
+
+# Image watermark
+sane_figs.setup(
+    mode='article',
+    watermark=sane_figs.create_image_watermark('logo.png', opacity=0.2)
+)
+```
+
+## Presets
+
+### Article Mode
+
+Optimized for print publication:
+- Figure size: (6.4, 4.8) inches
+- DPI: 300
+- Title: 14pt
+- Axis labels: 12pt
+- Legend: 10pt
+- Tick labels: 10pt
+
+### Presentation Mode
+
+Optimized for slides:
+- Figure size: (10, 7.5) inches
+- DPI: 150
+- Title: 24pt
+- Axis labels: 20pt
+- Legend: 16pt
+- Tick labels: 16pt
+
+## Colorways
+
+- **default**: Publication-ready palette optimized for print
+- **nature**: Earth tones inspired by nature
+- **vibrant**: High contrast colors for presentations
+- **pastel**: Soft, professional colors
+- **colorblind-safe**: Designed for colorblind accessibility
+
+## API Reference
+
+### Main Functions
+
+- `setup(mode='article', libraries=None, colorway=None, watermark=None)` - Apply publication defaults globally
+- `publication_style(mode='article', libraries=None, colorway=None, watermark=None)` - Context manager for scoped styling
+- `list_colorways()` - List available colorways
+- `create_text_watermark(text, **kwargs)` - Create a text watermark configuration
+- `create_image_watermark(image_path, **kwargs)` - Create an image watermark configuration
+
+### Per-Library Functions
+
+- `setup_matplotlib(mode='article', colorway=None, watermark=None)`
+- `setup_seaborn(mode='article', colorway=None, watermark=None)`
+- `setup_plotly(mode='article', colorway=None, watermark=None)`
+- `setup_altair(mode='article', colorway=None, watermark=None)`
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

sane_figs-0.1.0/README.md

@@ -0,0 +1,155 @@
+# Sane-Figs
+
+Publication-ready figures for Matplotlib, Seaborn, Plotly, and Altair.
+
+## Overview
+
+Sane-Figs is a Python package that automatically applies publication-ready styling to figures generated with popular Python visualization libraries. It solves the common problem of figures having text that is too small for articles and presentations.
+
+## Features
+
+- **Automatic Styling**: Apply publication-ready defaults with a single function call
+- **Multiple Libraries**: Support for Matplotlib, Seaborn, Plotly, and Altair
+- **Version-Aware**: Automatically detects library versions and adapts to API changes
+- **Two Usage Modes**: Global setup or context manager for scoped styling
+- **Presets**: Built-in presets for articles and presentations
+- **Colorways**: Publication-ready color palettes (default, nature, vibrant, pastel, colorblind-safe)
+- **Watermarks**: Text and image watermark support
+
+## Installation
+
+```bash
+pip install sane-figs
+```
+
+For full library support:
+
+```bash
+pip install sane-figs[all]
+```
+
+Or install with specific libraries:
+
+```bash
+pip install sane-figs[matplotlib,seaborn]
+```
+
+## Quick Start
+
+### Global Setup
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Apply publication defaults globally
+sane_figs.setup(mode='article')
+
+# Your existing code works as-is
+plt.plot([1, 2, 3], [1, 4, 9])
+plt.title('My Figure')
+plt.xlabel('X Axis')
+plt.ylabel('Y Axis')
+plt.savefig('figure.png', dpi=300)
+```
+
+### Context Manager
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Scoped styling
+with sane_figs.publication_style(mode='article'):
+    plt.plot([1, 2, 3], [1, 4, 9])
+    plt.title('My Figure')
+    plt.savefig('figure.png')
+
+# Styling resets after context
+plt.plot([1, 2, 3], [1, 4, 9])  # Back to default styling
+```
+
+### With Colorways
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Apply colorway
+sane_figs.setup(mode='article', colorway='nature')
+
+# List available colorways
+print(sane_figs.list_colorways())
+# ['default', 'nature', 'vibrant', 'pastel', 'colorblind-safe']
+```
+
+### With Watermarks
+
+```python
+import sane_figs
+import matplotlib.pyplot as plt
+
+# Text watermark
+sane_figs.setup(mode='article', watermark='© 2025 My Lab')
+
+# Image watermark
+sane_figs.setup(
+    mode='article',
+    watermark=sane_figs.create_image_watermark('logo.png', opacity=0.2)
+)
+```
+
+## Presets
+
+### Article Mode
+
+Optimized for print publication:
+- Figure size: (6.4, 4.8) inches
+- DPI: 300
+- Title: 14pt
+- Axis labels: 12pt
+- Legend: 10pt
+- Tick labels: 10pt
+
+### Presentation Mode
+
+Optimized for slides:
+- Figure size: (10, 7.5) inches
+- DPI: 150
+- Title: 24pt
+- Axis labels: 20pt
+- Legend: 16pt
+- Tick labels: 16pt
+
+## Colorways
+
+- **default**: Publication-ready palette optimized for print
+- **nature**: Earth tones inspired by nature
+- **vibrant**: High contrast colors for presentations
+- **pastel**: Soft, professional colors
+- **colorblind-safe**: Designed for colorblind accessibility
+
+## API Reference
+
+### Main Functions
+
+- `setup(mode='article', libraries=None, colorway=None, watermark=None)` - Apply publication defaults globally
+- `publication_style(mode='article', libraries=None, colorway=None, watermark=None)` - Context manager for scoped styling
+- `list_colorways()` - List available colorways
+- `create_text_watermark(text, **kwargs)` - Create a text watermark configuration
+- `create_image_watermark(image_path, **kwargs)` - Create an image watermark configuration
+
+### Per-Library Functions
+
+- `setup_matplotlib(mode='article', colorway=None, watermark=None)`
+- `setup_seaborn(mode='article', colorway=None, watermark=None)`
+- `setup_plotly(mode='article', colorway=None, watermark=None)`
+- `setup_altair(mode='article', colorway=None, watermark=None)`
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

sane_figs-0.1.0/pyproject.toml

@@ -0,0 +1,143 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sane-figs"
+version = "0.1.0"
+description = "Publication-ready figures for Matplotlib, Seaborn, Plotly, and Altair"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Jean-David T.", email = "jeandavid@example.com"}
+]
+maintainers = [
+    {name = "Jean-David T.", email = "jeandavid@example.com"}
+]
+keywords = [
+    "visualization",
+    "matplotlib",
+    "seaborn",
+    "plotly",
+    "altair",
+    "publication",
+    "figures",
+    "plotting",
+    "scientific",
+    "research"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "importlib-metadata; python_version < '3.8'",
+    "Pillow>=9.0.0",
+    "PyYAML>=6.0",
+]
+
+[project.optional-dependencies]
+matplotlib = ["matplotlib>=2.0.0"]
+seaborn = ["seaborn>=0.9.0", "matplotlib>=2.0.0"]
+plotly = [
+    "altair>=5.4.1",
+    "pandas>=2.0.3",
+    "plotly>=4.0.0",
+]
+altair = ["altair>=3.0.0"]
+all = [
+    "matplotlib>=2.0.0",
+    "seaborn>=0.9.0",
+    "plotly>=4.0.0",
+    "altair>=3.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-regressions>=2.5.0",
+    "pytest-xdist>=3.0.0",
+    "packaging>=23.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.0.0",
+]
+test = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-regressions>=2.5.0",
+    "pytest-xdist>=3.0.0",
+    "packaging>=23.0.0",
+    "pandas>=1.0.0",
+]
+docs = [
+    "mkdocs>=1.5.0",
+    "pymdown-extensions>=10.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/jeandavidt/sane-figs"
+Documentation = "https://sane-figs.readthedocs.io"
+Repository = "https://github.com/jeandavidt/sane-figs"
+Issues = "https://github.com/jeandavidt/sane-figs/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sane_figs*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+
+[tool.ruff]
+line-length = 100
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --cov=sane_figs --cov-report=term-missing --strict-markers"
+markers = [
+    "visual: marks tests as visual regression tests",
+    "matplotlib_min: tests for matplotlib minimum version (2.0.x)",
+    "matplotlib_3_0: tests for matplotlib 3.0+",
+    "matplotlib_3_5: tests for matplotlib 3.5+",
+    "seaborn_0_11: tests for seaborn 0.11+",
+    "seaborn_0_12: tests for seaborn 0.12+",
+    "plotly_5_0: tests for plotly 5.0+",
+    "altair_5_0: tests for altair 5.0+",
+    "matplotlib: tests requiring matplotlib",
+    "seaborn: tests requiring seaborn",
+    "plotly: tests requiring plotly",
+    "altair: tests requiring altair",
+]
+
+[tool.uv.sources]
+sane-figs = { workspace = true }
+
+[dependency-groups]
+dev = [
+    "marimo>=0.8.22",
+    "mkdocs>=1.6.1",
+    "plotly>=6.5.2",
+    "pymdown-extensions>=10.0",
+    "sane-figs",
+]