Merge branch 'main' of github.com:UBC-MDS/hexdropper

README.md

@@ -2,6 +2,13 @@
 
 A Python package designed for graphic designers, developers, and color enthusiasts. It simplifies the process of obtaining hex color codes from images. Given a cropped image, hexdropper quickly identifies and outputs the corresponding hex color code, streamlining design and development workflows.
 
+## Contributors
+
+- [Julia Everitt](https://github.com/juliaeveritt)
+- [Hancheng Qin](https://github.com/hchqin)
+- [Joey Wu](https://github.com/joeywwwu)
+- [Mona Zhu](https://github.com/monazhu)
+
 ## Features
 The key functionalities include:
 
@@ -15,10 +22,68 @@ The key functionalities include:
 
 ## Installation
 
-```bash
-$ pip install hexdropper
+The current package is still under development. We have provided below a set of developer installation instructions.
+
+### Developer Installation
+
+#### Getting Started
+
+Clone a copy of [this repository](https://github.com/UBC-MDS/hexdropper) onto your local machine. See [this page](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) for details on how to clone a repository.
+
+#### Setting up a Conda Environment
+
+We recommend creating an isolated conda environment on your local machine to test and develop the package. To create a conda environment for this project, type in the below command in your terminal, replacing `[your_env_name]` with your desired environment name (e.g., hexdropper)
+
+```
+$ conda create --name [your_env_name] python=3.9 -y
+```
+
+#### Using Poetry for Package Management
+
+Please follow the official poetry [documentation](https://python-poetry.org/docs/) to install poetry on your local machine. Note that poetry should **always be installed on a dedicated virtual environment.**
+
+Navigate to the root directory of your project folder. Ensure that your virtual conda environment has been activated. Run the following line of code to install existing packages required for the `hexdropper` package:
+
+```
+$ poetry install
 ```
 
+If you would like to add a new package or dependency, run the following code in your terminal, replacing `[name-of-dependency]` with the package you would like to install (e.g., numpy)
+
+```
+$ poetry add [name-of-dependency]
+```
+
+You can also pin the specific version of the package you would like to install like so: 
+
+```
+$ poetry add numpy=1.22.0 --dry-run
+```
+
+#### Running Tests
+
+Ensure `pytest` and `pytest-cov` are installed via poetry. If not, run the following in your terminal: 
+
+```
+$ poetry add --group dev pytest
+```
+```
+$ poetry add --group dev pytest-cov
+```
+
+Ensuring that your test scripts are completed, then run the following code in your terminal to run the tests for all functions in the package: 
+
+```
+$ pytest tests/
+```
+
+To run coverage tests, run the following command:
+
+```
+$ pytest tests/ --cov=pycounts
+```
+
+
 ## Usage
 
 - TODO
@@ -29,13 +94,6 @@ hexdropper fills a unique niche in the Python ecosystem. While there are package
 - [Pillow](https://python-pillow.org/): For comprehensive image processing capabilities.
 - [Matplotlib](https://matplotlib.org/): For creating visualizations and figures.
 
-## Contributors
-
-- [Julia Everitt](https://github.com/juliaeveritt)
-- [Hancheng Qin](https://github.com/hchqin)
-- [Joey Wu](https://github.com/joeywwwu)
-- [Mona Zhu](https://github.com/monazhu)
-
 ## Contributing
 
 Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hexdropper"
-version = "0.1.0"
+version = "2.0.0"
 description = "Python package for determining the hex colour code given a cropped image."
 authors = ["Julia Everitt, Hancheng Qin, Joey Wu, Mona Zhu"]
 license = "MIT"
@@ -16,6 +16,7 @@ matplotlib = "^3.8.2"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.4"
+pytest-cov = "^4.1.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

tests/test_create_color_image.py

@@ -1,8 +1,6 @@
 import pytest
 import os
 from PIL import Image
-import sys
-sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
 from hexdropper.create_color_image import create_color_image
 
 # Test data

tests/test_read_image.py

@@ -1,9 +1,6 @@
 import pytest
-import sys
-import os
 import numpy as np
-sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
-from src.hexdropper.read_image import read_image
+from hexdropper.read_image import read_image
 
 # Test data
 filepath_cropped_image_jpg = "tests/images/cropped_img.jpg"

tests/test_rgb_to_hex.py

@@ -1,7 +1,4 @@
-import sys
-import os
-sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
-from src.hexdropper.rgb_to_hex import rgb_to_hex
+from hexdropper.rgb_to_hex import rgb_to_hex
 
 def test_standard_colors():
     assert rgb_to_hex(255, 0, 0) == '#FF0000'