Fix the README

[shlecturer]

The README can do with a bit of TLC.

An example that shows how to use it, for example, would be nice.

Great first issue as it does not involve any coding.

[byw2]

can i please be assigned to this? thanks!

also, i am new to contributing to open source projects: can you please explain how to use this module/execute the scripts?

[Sandyman]

Well, this is the source code for a Python "package". It has been published on the Python Package Inventory, or PyPi. See this link: https://pypi.org/project/colourise/

Packages are usually installed with pip install colourise. You can also install local packages from a folder with (I think) pip install -e <path to folder>. This is useful for testing.

The setup script is used to describe what the package is about. Have a look at that too.

The general Python documentation has excellent information about creating packages. Have a look here: https://packaging.python.org/tutorials/packaging-projects/

[aphive]

I think this would be a great starting point. @byw2, feel free to use it as a foundation if you'd like.

Colourise

Colourise allows you to convert color formats, for example converts HSL values (hue, saturation, and lightness) to RGB values (Red, Green, Blue) as well as calculating complementary colors.

How to install

Installing Colourise is as simple as running the following command:

Requires: Python >=3.7

• For Mac or Linux:

python3 -m pip install --upgrade colourise

• For Windows:

py -m pip install --upgrade colourise

Note: The above commands also allow you to upgrade when a new version is released.

What can Colourise do?

• Convert any HSL value to RGB.
• Convert RGB colours to HSL.
• Convert HSL to RGB colours. This function assumes the input has been sanitised and does no validation on the input parameters.
• Convert normalised RGB colours to HSL. This function assumes the input has been sanitised and does no validation on the input parameters.
• Calculate the complement of a given value as HSL values.
• Convert an RGB colours to its complementary colour.

Reference

• HSL and HSV

Contributing

If you want to contribute, have a look at the Issues. Some issues are labeled 'Good first issue'. They are the low-hanging fruit.

If you create a PR, also add your GitHub username to the list of contributors in the file contributors.txt. It's a bit of recognition for your work.

[aphive]

@Sandyman, are there any requirements to get this up and running? Would be nice to get a requirements file generated so it can be used during install/upgrade.

[Sandyman]

@Sandyman, are there any requirements to get this up and running? Would be nice to get a requirements file generated so it can be used during install/upgrade.

There are no dependencies for this package, which is why it does not need a requirements.txt.