Metadata-Version: 2.4
Name: artpack
Version: 0.2.0.post1
Summary: Create data that displays generative art when mapped into a 'plotnine' plot. Functionality includes specialized data frame creation for geometric shapes, tools that define artistic color palettes, tools for geometrically transforming data, and other miscellaneous tools that are helpful when using 'plotnine' for generative art.
Project-URL: Homepage, https://github.com/Meghansaha/artpack-py
Project-URL: Repository, https://github.com/Meghansaha/artpack-py
Author-email: "Meghan S. Harris" <meghanha01@gmail.com>
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: build>=1.3.0
Requires-Dist: matplotlib==3.8.4
Requires-Dist: numpy==1.26.4
Requires-Dist: pandas==2.2.2
Requires-Dist: plotnine>=0.12.0
Requires-Dist: polars
Requires-Dist: pyarrow
Provides-Extra: dev
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: quartodoc; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# artpack

<p align="center" width="100%">
<img src="https://raw.githubusercontent.com/Meghansaha/artpack-py/main/assets/img/artpack-py-logo.png" alt="Hexagonal logo with colorful, flowing wave patterns in rainbow hues. White text reads 'aRtpack' with a paintbrush accent, and Python logo in bottom right corner.">
</p>

Python port of the R package [artpack](https://CRAN.R-project.org/package=artpack), bringing generative art color palettes to the Python ecosystem.

## About

artpack provides curated color palettes designed for generative art and data visualization. This is a work-in-progress port of the original R package.

## Installation

```bash
pip install artpack-py
```

## Quick Start

```python
from artpack import art_pals

# Get 5 colors from the ocean palette
colors = art_pals("ocean", n=5)
print(colors)
# ['#12012E', '#144267', '#15698C', '#0695AA', '#156275']

# Reverse the palette
colors_rev = art_pals("ocean", n=5, direction = "reverse")

# Randomize color order
colors_random = art_pals("rainbow", n = 10, randomize = True)
```

## Available Palettes

`"arctic"`, `"beach"`, `"bw"`, `"brood"`, `"cosmos"`, `"explorer"`, `"gemstones"`, `"grays"`, `"icecream"`, `"imagination"`, `"majestic"`, `"nature"`, `"neon"`, `"ocean"`, `"plants"`, `"rainbow"`, `"sunnyside"`, `"super"`

## Development Status

🚧 **Work in Progress** - Currently porting core functionality from the R version. More features coming soon!

**Currently implemented:**
- ✅ Color palette generation (`art_pals()`)
- ✅ Circle data generation (`circle_data()`)
- ✅ 100% test coverage
- ✅ CI/CD with GitHub Actions

**Roadmap:**
- Additional color palette tools (Functions that help with color-related tasks.)
- Asset creation (Functions that help with making data for generative art.)
- Geometric testing tools (Functions that help with geometric/spatial analysis for generative art.)
- Grouping tools (Functions that help with grouping generative art data.)
- Sequencing tools (Functions that help with numeric sequencing.)
- Transformation tools (Functions that help with transforming existing generative art data.)

## Links

- **Python Package (PyPI):** [artpack-py](https://pypi.org/project/artpack-py/)
- **Original R Package (CRAN):** [artpack](https://CRAN.R-project.org/package=artpack)
- **GitHub Repository:** [github.com/Meghansaha/artpack-py](https://github.com/Meghansaha/artpack-py)

## License

MIT License

Copyright (c) 2025 Meghan Harris

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.

## Author

Meghan Harris ([@meghansaha](https://github.com/Meghansaha))