ImageGoNord icon indicating copy to clipboard operation
ImageGoNord copied to clipboard

A tool that can convert your rgb images to nordtheme palette

ImageGoNord - RGB image to Nordtheme palette

A tool that can convert your rgb images to nordtheme palette.

This repository is:

  • CLI utility, written in python, that can convert any sort of image into a nordtheme palette image;
  • an API hosted on Heroku that is using the ImageGoNord Python package written in Flask;
  • a demo website hosted on Netlify made using the Nordtheme and VueJS;

Are you looking for the python package?

The official python package's repository is ImageGoNord-pip. You are welcome :)

Inspiration

We are in love with Nordtheme, that is why we created this repository.

Nord Color Palette Overview

Our goal is to make a shortcut to convert anything into this theme, by starting from the images.
An example could be an awesome wallpaper converted into the Nordtheme palette.

We checked the commnunity and we did not find anything similar or any project that can accomplish this task. So, here we are.

Core Technical Concepts

We are using the PIL because it is the most simple library and it is very useful when you need to manipulate some images.

Our goal is also to make this project open source and maintainable by the community. We would love to.

We believe in the open source community.

Getting Started

Include any essential instructions for:

  • Getting it:
    git clone https://github.com/Schrodinger-Hat/ImageGoNord
    
  • Enter to the folder
    cd ImageGoNord
    
  • Installing It
    pip install -r requirements.txt
    
  • Running it
    python src/cli.py --img='<path_to_your_image>' 
    

The algorithm can takes some time (we are working on improving it), you can find the result with the name nord.png.

You can define some more configuration and use different palettes, find more using:

python src/cli.py --help

Testing

  • Tests TODO

Contributing

  • Follow the contributor guidelines
  • Follow the code style / requirements
  • Format for commit messages

TODO

  • Portable environemnt
  • Testing
  • Improvements on image quality and supporting any image format
  • Make contributing guidelines
  • API / UI

Authors

TheJoin95 & Wabri

NOTE: we are not (yet) affiliated with the Nordtheme or Arcticicestudio.

Credits

Nordtheme

License

MIT license