π³οΈβπ A Python command line interface tool for generating pride flags from images. The program accepts any image file and outputs the flag as a .png
file.
pyflagoras-preview-v2.mp4
(To see more examples of flags generated using this program, visit examples.md!)
Pyflagoras, at a minimum, needs the name of a pride flag and a path to an image to work.
It uses Pillow to generate a list of colours in the image.
The program then obtains the flag's .svg
file from the alias used, and extracts the all the colours used in the flag. It uses an algorithm to calculate which colours are the most similar based on their RGB codes.
Finally, the colours are swapped out. The .svg
is converted into a .pdf
using svglib then into a .png
using PyMuPDF.
You can install this package from pypi.org! Open a terminal and run the following:
pip install pyflagoras
$ pyflagoras --help
usage: pyflagoras [-h] [-f FLAG] [-n NAME] [--verbose] [--svg] [--version] [-l] image
A command line interface tool for generating pride flags from images.
positional arguments:
image Path to the image to generate a flag from.
Examples:
image.png
foo/bar/image.jpg
options:
-h, --help show this help message and exit
-f FLAG, --flag FLAG The alias of the flag to generate.
Examples:
intersexinclusive
nonbinary
Default:
progresspride
-n NAME, --name NAME Customise the name of the final .png. The following can be used as part of the file name:
Format placeholders:
{n}: File name (e.g celeste_classic)
{N}: File name (full) (e.g celeste_classic.png)
{f}: Flag name (e.g Progress Pride)
{F}: Flag ID (e.g progressPride_2018)
Examples:
pyflagoras celeste_classic.png -n "{f}_{n}" [renders Progress Pride_celeste_classic.png]
Default:
{n}_{F} [renders celeste_classic_progressPride_2018.png]
--verbose Enable verbosity (for general info and debugging)
--svg Generate the flag's .svg file in addition to the .png
--version show the program's version number and exit
-l, --list show all flag aliases and exit
Documentation, issues and more: https://github.com/phthallo/pyflagoras
Tip: Using --verbose
will log the coordinates of where the colours were found on your image!
Substitute py
for python3
as necessary.
- Clone the repository.
git clone https://github.com/phthallo/pyflagoras
- Install the build tool.
py -m pip install --upgrade build
cd
to the root of the repository and build the package.py -m build
- Both the source distribution (
pyflagoras-x.x.x-tar.gz
) and the built distribution (pyflagoras-x.x.x-py3-none-any.whl
) will be found under the/dist
subdirectory. You can then install the wheel using:py -m pip install dist/pyflagoras-x.x.x-py3-none-any.whl
The current pride flags have been sourced from @/JoeHart's Pride Flag API.
To add a new flag, see addingflags.md.
- The name
pyflagoras
comes from python, pride flag, and the basic colour similarity algorithm being a 3D application of Pythagoras' theorem. - See also the prideflagbot account (gone but not forgotten!) run by @/michalpazur, which was a big inspiration for this project.