plotnine 0.16.0a6__tar.gz → 0.16.0a8__tar.gz

plotnine-0.16.0a8/Makefile

@@ -0,0 +1,134 @@
+.PHONY: clean-pyc clean-build doc clean visualize-tests build
+
+# NOTE: Take care not to use tabs in any programming flow outside the
+# make target
+
+# Use uv (if it is installed) to run all python related commands,
+# and prefere the active environment over .venv in a parent folder
+ifeq ($(OS),Windows_NT)
+  HAS_UV := $(if $(shell where uv 2>NUL),true,false)
+else
+  HAS_UV := $(if $(shell command -v uv 2>/dev/null),true,false)
+endif
+
+ifeq ($(HAS_UV),true)
+  PYTHON ?= uv run --no-sync --active python
+  PIP ?= uv pip
+  UVRUN ?= uv run --no-sync --active
+else
+  PYTHON ?= python
+  PIP ?= pip
+  UVRUN ?=
+endif
+
+BROWSER := $(PYTHON) -mwebbrowser
+
+all:
+	@echo "Using Python: $(PYTHON)"
+
+help:
+	@echo "clean - remove all build, test, coverage and Python artifacts"
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean-test - remove test and coverage artifacts"
+	@echo "lint - check style with ruff"
+	@echo "test - run tests quickly with the default Python"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "doc - generate HTML API documentation"
+	@echo "release - package and upload a release"
+	@echo "dist - package"
+	@echo "install - install the package to the active Python's site-packages"
+	@echo "develop - install the package in development mode"
+
+clean: clean-build clean-cache clean-test
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	find . -name '*.egg-info' -exec rm -fr {} +
+
+clean-cache:
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+	$(UVRUN) coverage erase
+	rm -f coverage.xml
+	rm -fr htmlcov/
+	rm -fr tests/result_images/*
+
+format:
+	$(UVRUN) ruff format --check .
+
+format-fix:
+	$(UVRUN) ruff format .
+
+lint:
+	$(UVRUN) ruff check .
+
+lint-fix:
+	$(UVRUN) ruff check --fix .
+
+fix: format-fix lint-fix
+
+typecheck:
+	$(UVRUN) pyright
+
+test0: clean-test
+	$(UVRUN) pytest
+
+test: clean-test
+	$(UVRUN) pytest -n auto
+
+test1: clean-test
+	$(UVRUN) pytest -n auto -p no:sugar
+
+visualize-tests:
+	$(PYTHON) tools/visualize_tests.py
+
+update-baseline-images:
+	$(PYTHON) tools/update_baseline_images.py
+
+coverage:
+	$(UVRUN) coverage report -m
+	$(UVRUN) coverage html
+	$(BROWSER) htmlcov/index.html
+
+doc:
+	$(MAKE) -C doc doc
+
+doc-preview:
+	$(MAKE) -C doc preview
+
+release-major:
+	@$(PYTHON) ./tools/release-checklist.py major
+
+release-minor:
+	@$(PYTHON) ./tools/release-checklist.py minor
+
+release-patch:
+	@$(PYTHON) ./tools/release-checklist.py patch
+
+dist: clean-build
+	$(PYTHON) -m build
+	ls -l dist
+
+build: dist
+
+install: clean
+	$(PIP) install ".[extra]"
+
+sync:
+	uv sync --all-extras
+
+doc-dependencies:
+	$(PIP) install -e ".[doc]"
+	$(PIP) install -r requirements/doc.txt
+	$(MAKE) -C doc dependencies
+
+develop: clean-cache
+	$(PIP) install -e ".[all]"
+	$(MAKE) doc-dependencies
+
+develop-update: clean-cache
+	$(PIP) install --upgrade -e ".[all]"
+	$(UVRUN) pre-commit autoupdate

plotnine-0.16.0a8/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: plotnine
+Version: 0.16.0a8
+Summary: A Grammar of Graphics for Python
+Author-email: Hassan Kibirige <has2k1@gmail.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2022 Hassan Kibirige
+        
+        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.
+        
+Project-URL: homepage, https://plotnine.readthedocs.io/en/stable
+Project-URL: repository, https://github.com/has2k1/plotnine
+Project-URL: changelog, https://plotnine.readthedocs.io/en/stable/changelog.html
+Project-URL: ci, https://github.com/has2k1/plotnine/actions
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Framework :: Matplotlib
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib>=3.8.0
+Requires-Dist: pandas>=2.2.0
+Requires-Dist: mizani~=0.14.0
+Requires-Dist: numpy>=1.23.5
+Requires-Dist: scipy>=1.8.0
+Requires-Dist: statsmodels>=0.14.6
+Provides-Extra: all
+Requires-Dist: plotnine[extra]; extra == "all"
+Requires-Dist: plotnine[doc]; extra == "all"
+Requires-Dist: plotnine[lint]; extra == "all"
+Requires-Dist: plotnine[test]; extra == "all"
+Requires-Dist: plotnine[build]; extra == "all"
+Requires-Dist: plotnine[dev]; extra == "all"
+Provides-Extra: extra
+Requires-Dist: adjustText>=1.2.0; extra == "extra"
+Requires-Dist: geopandas>=1.0.0; extra == "extra"
+Requires-Dist: geodatasets>=2024.8.0; extra == "extra"
+Requires-Dist: scikit-learn>=1.3.0; extra == "extra"
+Requires-Dist: scikit-misc>=0.5.1; extra == "extra"
+Requires-Dist: polars>=1.24.0; extra == "extra"
+Requires-Dist: pyarrow>=19.0.1; extra == "extra"
+Provides-Extra: doc
+Requires-Dist: jupyter; extra == "doc"
+Requires-Dist: click; extra == "doc"
+Requires-Dist: griffe==1.15.0; extra == "doc"
+Requires-Dist: numpydoc>=0.9.1; extra == "doc"
+Requires-Dist: quartodoc>=0.11.1; extra == "doc"
+Provides-Extra: lint
+Requires-Dist: ruff; extra == "lint"
+Provides-Extra: test
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.8.0; extra == "test"
+Requires-Dist: pytest-sugar>=1.1.1; extra == "test"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: wheel; extra == "build"
+Provides-Extra: dev
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: plotnine[typing]; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: typing
+Requires-Dist: pyright==1.1.408; extra == "typing"
+Requires-Dist: ipython; extra == "typing"
+Requires-Dist: pandas-stubs; extra == "typing"
+Dynamic: license-file
+
+# plotnine <img width="20%" align="right" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/logo-512.png?raw=true">
+
+[![Release](https://img.shields.io/pypi/v/plotnine.svg)](https://pypi.python.org/pypi/plotnine)
+[![License](https://img.shields.io/pypi/l/plotnine.svg)](https://pypi.python.org/pypi/plotnine)
+[![DOI](https://zenodo.org/badge/89276692.svg)](https://zenodo.org/badge/latestdoi/89276692)
+[![Build Status](https://github.com/has2k1/plotnine/workflows/build/badge.svg?branch=main)](https://github.com/has2k1/plotnine/actions?query=branch%3Amain+workflow%3A%22build%22)
+[![Coverage](https://codecov.io/github/has2k1/plotnine/coverage.svg?branch=main)](https://codecov.io/github/has2k1/plotnine?branch=main)
+
+plotnine is an implementation of a *grammar of graphics* in Python
+based on [ggplot2](https://github.com/tidyverse/ggplot2).
+The grammar allows you to compose plots by explicitly mapping variables in a
+dataframe to the visual characteristics (position, color, size etc.) of objects that make up the plot.
+
+Plotting with a *grammar of graphics* is powerful. Custom (and otherwise
+complex) plots are easy to think about and build incrementally, while the
+simple plots remain simple to create.
+
+To learn more about how to use plotnine, check out the
+[documentation](https://plotnine.org). Since plotnine
+has an API similar to ggplot2, where it lacks in coverage the
+[ggplot2 documentation](http://ggplot2.tidyverse.org/reference/index.html)
+may be helpful.
+
+
+## Example
+
+```python
+from plotnine import *
+from plotnine.data import mtcars
+```
+
+Building a complex plot piece by piece.
+
+1. Scatter plot
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg"))
+       + geom_point()
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-1.png?raw=true">
+
+2. Scatter plot colored according some variable
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg", color="factor(gear)"))
+       + geom_point()
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-2.png?raw=true">
+
+3. Scatter plot colored according some variable and
+   smoothed with a linear model with confidence intervals.
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg", color="factor(gear)"))
+       + geom_point()
+       + stat_smooth(method="lm")
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-3.png?raw=true">
+
+4. Scatter plot colored according some variable,
+   smoothed with a linear model with confidence intervals and
+   plotted on separate panels.
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg", color="factor(gear)"))
+       + geom_point()
+       + stat_smooth(method="lm")
+       + facet_wrap("gear")
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-4.png?raw=true">
+
+5. Adjust the themes
+
+
+   I) Make it playful
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg", color="factor(gear)"))
+       + geom_point()
+       + stat_smooth(method="lm")
+       + facet_wrap("gear")
+       + theme_xkcd()
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-5.png?raw=true">
+
+   II) Or professional
+
+   ```python
+   (
+       ggplot(mtcars, aes("wt", "mpg", color="factor(gear)"))
+       + geom_point()
+       + stat_smooth(method="lm")
+       + facet_wrap("gear")
+       + theme_tufte()
+   )
+   ```
+
+   <img width="90%" align="center" src="https://github.com/has2k1/plotnine/blob/logos/doc/images/readme-image-5alt.png?raw=true">
+
+## Installation
+
+Official release
+
+```console
+# Using pip
+$ pip install plotnine             # 1. should be sufficient for most
+$ pip install 'plotnine[extra]'    # 2. includes extra/optional packages
+$ pip install 'plotnine[test]'     # 3. testing
+$ pip install 'plotnine[doc]'      # 4. generating docs
+$ pip install 'plotnine[dev]'      # 5. development (making releases)
+$ pip install 'plotnine[all]'      # 6. everything
+
+# Or using conda
+$ conda install -c conda-forge plotnine
+
+# Or using pixi
+$ pixi init name-of-my-project
+$ cd name-of-my-project
+$ pixi add python plotnine
+```
+
+Development version
+
+```console
+$ pip install git+https://github.com/has2k1/plotnine.git
+```
+
+## Contributing
+
+Our documentation could use some examples, but we are looking for something
+a little bit special. We have two criteria:
+
+1. Simple looking plots that otherwise require a trick or two.
+2. Plots that are part of a data analytic narrative. That is, they provide
+   some form of clarity showing off the `geom`, `stat`, ... at their
+   differential best.
+
+If you come up with something that meets those criteria, we would love to
+see it. See [plotnine-examples](https://github.com/has2k1/plotnine-examples).
+
+If you discover a bug checkout the [issues](https://github.com/has2k1/plotnine/issues)
+if it has not been reported, yet please file an issue.
+
+And if you can fix a bug, your contribution is welcome.
+
+Testing
+-------
+
+Plotnine has tests that generate images which are compared to baseline images known
+to be correct. There may be small differences in the text rendering that throw off the
+image comparisons, and the tests allow some very small differences.