Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update client with argparse (#3) #25

Merged
merged 5 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -252,3 +252,4 @@ cython_debug/
#.idea/

# End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all
nord.png
27 changes: 27 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"files.autoSave": "afterDelay",
"files.autoSaveDelay": 400,
"editor.formatOnSave": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true,
},
"python.envFile": "${workspaceFolder}/.env",
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
"python.testing.cwd": "${workspaceFolder}",
"python.testing.autoTestDiscoverOnSaveEnabled": true,
"terminal.integrated.env.osx": {
"PYTHONIOENCODING": "utf-8",
"PYTHONPATH": "${workspaceFolder}/src:${workspaceFolder}/tests"
},
"python.analysis.typeCheckingMode": "strict",
"python.testing.unittestArgs": [
"-v",
"-s",
"tests",
"-p",
"test*.py"
],
"editor.rulers": [80, 120]
}
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,27 @@ Include any essential instructions for:
```

- 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='<path_to_your_image>'
```
python src/cli.py --img='<path_to_your_image>'
Or if you prefer
```shell
export PYTHONPATH=$PYTHONPATH:$PWD/src:$PWD/tests
cd src
python image_go_nord_client --img='<path_to_your_image>'
```

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:

```
python src/cli.py --help
```shell
python src/image_go_nord_client --img='<path_to_your_image>'
```

### Contributing
Expand Down
1 change: 0 additions & 1 deletion src/VERSION

This file was deleted.

277 changes: 0 additions & 277 deletions src/cli.py

This file was deleted.

47 changes: 0 additions & 47 deletions src/configs/arguments.py

This file was deleted.

1 change: 1 addition & 0 deletions src/image_go_nord_client/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.0.0
Loading