cube707 / badges Goto Github PK

use utllib to represent the url and params parts inside the class and construct it on request, making it much more mantanable and reducing errors that might happen with the manuall sting manipulation

The interface should consist of these commands:

• create a single badge.
• generate a set of badges at once, from a dataset
• check if a dataset is valid, not jet sure if fthis makes sens

the api should consist of functions that a user can use to get the comandline functionalaty directly from within python. So the same functions are required:

• create_badge() for a single badge
• generate_badges() for multiple badges at once
• check() or validate_dataset() to validate a dataset

the request should be async, so that the generate command can work on multiple badges in paralel while waiting for server responses.

see: https://click.palletsprojects.com/en/8.1.x/testing/

There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.

when using a svg-file and send it to the server, it would be nice to be able to optimize the svg, redicing the size as much as possible

get a first working demo.

once #4 is implemented, only getting the svg data requires a internet connection, so it might be usefull to give an option to disable requests if a user wants to work offline

the names usable on simpleicons should be cached in the package instead of requiering a web-request every time. Ther is a list at https://github.com/simple-icons/simple-icons/blob/develop/_data/simple-icons.json

either update it via a github-workflow or, even better, have a update function that gets called wehen the CLI finishes

if the keyword 'brand' gets passed as a color and simpleicon is used, the brandcolor should be picked automatically

depends on #4