Metadata-Version: 2.4
Name: everforest-factory
Version: 2.0.1
Summary: convert any image to the everforest palette! (fork of gruvbox-factory)
Author: dorpivovar
License: MIT
Project-URL: Homepage, https://github.com/dorpivovar/everforest-factory
Project-URL: Bug Tracker, https://github.com/dorpivovar/everforest-factory/issues
Project-URL: Upstream, https://github.com/paulopacitti/gruvbox-factory
Keywords: everforest,cli,everforest-factory,wallpaper,image,image-go-nord,palette,factory
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.13.1
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: charset-normalizer>=3.4.1
Requires-Dist: ffmpeg-python>=0.2.0
Requires-Dist: future>=1.0.0
Requires-Dist: idna>=3.10
Requires-Dist: image-go-nord>=1.2.0
Requires-Dist: markdown-it-py>=3.0.0
Requires-Dist: mdurl>=0.1.2
Requires-Dist: numpy>=2.0.0
Requires-Dist: pick>=2.4.0
Requires-Dist: pillow>=11.0.0
Requires-Dist: Pygments>=2.19.1
Requires-Dist: requests>=2.32.0
Requires-Dist: rich>=13.9.4
Dynamic: license-file

# everforest-factory 🏭
![License](https://img.shields.io/github/license/dorpivovar/everforest-factory?color=a7c080&style=flat-square)
![PyPI](https://img.shields.io/pypi/v/everforest-factory?color=e67e80&style=flat-square)

> A fork of [gruvbox-factory](https://github.com/paulopacitti/gruvbox-factory) by [@paulopacitti](https://github.com/paulopacitti), adapted to the [Everforest](https://github.com/sainnhe/everforest) color scheme.

> _"Comfortable & Pleasant Color Scheme for Vim"_ - [sainnhe](https://github.com/sainnhe)

![example of everforest-factory](https://raw.githubusercontent.com/dorpivovar/everforest-factory/master/example.png)

- A simple `cli` to ~~convert~~ manufacture an [everforest](https://github.com/sainnhe/everforest) themed wallpaper.
- Three color palettes: *dark*, *light* and smooth *mix*.

## Requirements

- Python 3.13.1 or higher

## Installation

### From PyPI

```bash
pip install everforest-factory
```

### From source

```bash
git clone https://github.com/dorpivovar/everforest-factory.git
cd everforest-factory
pip install .
```

For development (editable mode):

```bash
pip install -e .
```

> **Note:** if `pip install` reports that the script is installed in a directory not on PATH (e.g. `/var/data/python/bin`), add it:
> ```bash
> export PATH="/var/data/python/bin:$PATH"
> ```
> Or run directly via `python -m factory`.

## Usage

```
everforest-factory [-h] [-p [{dark,light,mix}]] [-i IMAGES [IMAGES ...]]
```

### Options

| Flag | Description |
|------|-------------|
| `-h`, `--help` | Show help message and exit |
| `-p`, `--palette` | Choose palette: `dark` (default), `light`, or `mix` |
| `-i`, `--images` | Path(s) to the image(s) to process |

### Examples

**Convert a single image with the dark palette (default):**

```bash
everforest-factory -i wallpaper.png
```

**Use the light palette:**

```bash
everforest-factory -p light -i photo.jpg
```

**Process multiple images at once:**

```bash
everforest-factory -p mix -i image1.png image2.jpg image3.webp
```

**Use a glob pattern:**

```bash
everforest-factory -p dark -i ~/Pictures/*.png
```

**Run without installing (from the project directory):**

```bash
python -m factory -p dark -i wallpaper.png
```

### Output

Processed images are saved in the same directory as the originals with the `everforest_` prefix:

```
wallpaper.png → everforest_wallpaper.png
```

## Palettes

| Palette | Description |
|---------|-------------|
| `dark`  | Everforest Dark — deep green-tinted backgrounds with warm accents |
| `light` | Everforest Light — soft cream backgrounds with vivid accents |
| `mix`   | Extended blend of both dark and light palettes with intermediate tones |


## Acknowledgements

This project is a fork of [gruvbox-factory](https://github.com/paulopacitti/gruvbox-factory) by [@paulopacitti](https://github.com/paulopacitti) and its contributors:
- [@H4ppy-04](https://github.com/H4ppy-04)
- [@Gabulhas](https://github.com/Gabulhas)
- [@hza2002](https://github.com/hza2002)
- [@jasonmishi](https://github.com/jasonmishi)
- [@perpetualCreations](https://github.com/perpetualCreations)
- [@Kuuhhl](https://github.com/Kuuhhl)
- [@marcelofern](https://github.com/marcelofern)

Built on top of [ImageGoNord](https://github.com/Schroedinger-Hat/ImageGoNord-Web).

Everforest color scheme by [sainnhe](https://github.com/sainnhe/everforest).
