.. pigmenta documentation master file, created by
   sphinx-quickstart on Thu Jun 12 12:27:46 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ``pigmenta`` Documentation
=====================================

``pigmenta`` is a lightweight Python package that provides easy access to a curated collection of beautiful color palettes. It is designed for developers, designers, data scientists, and artists who want to use harmonious and theme-based color palettes in visualizations, UI design, machine learning plots, or generative art.


- **Version**: ``0.0.2``
- **License**: ``MIT``
- **Author**: ``Crispen Gari``
- **Python Compatibility**: Python ``3.9+``

.. image:: images/logo.png
   :align: center
   :width: 200

.. raw:: html

   <p align="center">
      <a href="https://pypi.python.org/pypi/pigmenta"><img src="https://badge.fury.io/py/pigmenta.svg"></a>
      <a href="https://github.com/crispengari/pigmenta/actions/workflows/ci.yml"><img src="https://github.com/crispengari/pigmenta/actions/workflows/CI.yml/badge.svg"></a>
      <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green"></a>
      <a href="https://pypi.python.org/pypi/pigmenta"><img src="https://img.shields.io/pypi/pyversions/pigmenta.svg"></a>
   </p>



.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Getting Started

   installation
   usage

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: GitHub and Contribution

   github/contribution
   github/license


🚀 Features
++++++++++++
- Access over 30 named color palettes.
- Themes include: `pastel`, `vintage`, `neon`, `sunset`, `earth`, `skin`, `space`, and more.
- Easy integration with libraries like Matplotlib, Seaborn, Plotly, or your own app.
- Simple API via a class or dictionary.
- Extensible and open-source.


💡 Use Cases
+++++++++++++

- Visualizing data in elegant color themes.
- Designing dashboards or GUIs.
- Generative art and graphics programming.
- Branding and UI prototyping.

🧩 Future Plans
++++++++++++++++

- Add support for gradient generation.
- Integration with design tools or Jupyter extensions.
