https://github.com/schroedinger-hat/imagegonord-cli
A python client used for ImageGoNord
https://github.com/schroedinger-hat/imagegonord-cli
hacktoberfest
Last synced: 3 months ago
JSON representation
A python client used for ImageGoNord
- Host: GitHub
- URL: https://github.com/schroedinger-hat/imagegonord-cli
- Owner: Schroedinger-Hat
- License: gpl-3.0
- Created: 2022-08-22T19:45:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T10:16:47.000Z (12 months ago)
- Last Synced: 2025-07-08T18:28:54.372Z (3 months ago)
- Topics: hacktoberfest
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ImageGoNord client
ImageGoNord is a tool that can convert your rgb images to nordtheme palette.
You can find more information here: [ImageGoNord](https://github.com/schroedinger-Hat/ImageGoNord)
This repository is a client, written in python, that can convert any sort of image into a nordtheme palette image.
## Getting Started
Include any essential instructions for:
- Getting it:
```
git clone https://github.com/schroedinger-Hat/ImageGoNord-cli
```
- Install dependencies
```shell
pip install -r requirements.txt
```
- Running it
```shell
export PYTHONPATH=$PYTHONPATH:$PWD/src:$PWD/tests
python src/image_go_nord_client --img=''
```
Or if you prefer
```shell
export PYTHONPATH=$PYTHONPATH:$PWD/src:$PWD/tests
cd src
python image_go_nord_client --img=''
```
The algorithm can take 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:
```shell
python src/image_go_nord_client --img=''
```
### Contributing
- Follow the contributor guidelines
- Follow the code style / requirements
- Format for commit messages
# Authors
[TheJoin95](https://github.com/TheJoin95) & [Wabri](https://github.com/Wabri)
**NOTE**: we are not (yet) affiliated with the Nordtheme or [Arcticicestudio](https://github.com/arcticicestudio).
# Credits
[Nordtheme](https://www.nordtheme.com/)