Restructured project for PyPI packaging

This commit is contained in:
NicklasVraa
2023-08-06 15:09:05 +02:00
parent a6d1beb2bf
commit 8bf4de77dd
6 changed files with 17 additions and 16 deletions

View File

View File

@@ -36,7 +36,7 @@ Speeds were recorded with an Intel i7-4770K CPU. Any svg-based icon pack can ser
## Using the Program<a name="use"></a>
Either import `recolor` into your own script and call the recoloring functions, e.g.:
```python
import recolor as rc
from color_manager import recolor as rc
```
```python
src = "packs/papirus-mini_mono"
@@ -47,7 +47,7 @@ hsl = (0.5, 0.5, 0.5) # = rc.normalize_hsl(180, 50, 50)
rc.monochrome_pack(src, dest, name, hsl)
```
```python
src = "packs/papirus-multi_mono"
src = "packs/papirus-mini_multi"
name = "my_multi_pack"
dest = "~/Downloads"
palette = "palettes/dracula.json"
@@ -55,7 +55,7 @@ palette = "palettes/dracula.json"
rc.multichrome_pack(src, dest, name, palette)
```
Or launch the GUI by running `python3 color_manager.py`. The GUI will adopt your active theme. Dependencies: `colormath`, `tqdm`, `json`. With GUI `PyGObject` must also be installed.
Or launch the GUI by running `python3 color_manager/gui.py` in a terminal from the project's root directory. The GUI will adopt your active theme. Dependencies: `colormath` and `tqdm`. For the GUI, `pygobject` (GTK bindings) must also be installed.
## Requests <a name="requests"></a>

View File

@@ -2,26 +2,18 @@
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import recolor as rc"
"from color_manager import recolor as rc"
]
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"Processing SVGs: 100%|██████████| 7980/7980 [00:01<00:00, 6403.61 file/s]\n"
]
}
],
"outputs": [],
"source": [
"src = \"packs/papirus-mini_mono\"\n",
"name = \"my_mono_pack\"\n",
@@ -37,13 +29,22 @@
"metadata": {},
"outputs": [],
"source": [
"src = \"packs/papirus-multi_mono\"\n",
"src = \"packs/papirus-mini_multi\"\n",
"name = \"my_multi_pack\"\n",
"dest = \"~/Downloads\"\n",
"palette = \"palettes/dracula.json\"\n",
"\n",
"rc.multichrome_pack(src, dest, name, palette)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"from color_manager import gui"
]
}
],
"metadata": {