README.md
Vortex image processing
This is the README file for the directory containing the image processing software created and used by Vortex.
Getting Started:
:package: Prerequisites:
Make sure that you have the following installed on your system:
:test_tube: Testing
The automated tests are stored in the tests directory. Make sure to install pytest. The tests can be ran by using the command pytest .. The commands will run the test define the the test_*.py files. Make sure that you are in the YOLO-detect-buoys directory. The naming convention of testing files is comprised of the word test_ followed by the name of the file to which the test is related: test_<FILE_NAME>.py. An example of that is tests/test_utils.py which is a python test file tah tests the functions utils.
:rotating_light: Linting
Linting improves code quality by ensuring the the codebase does not contain bad-practices. Make sure to install PyLint globally in order to use CLI. Use the command pylint $(git ls-files '*.py') in order to lint the files tracked by git. PyLint is used as the Python linter in this project. Make sure to install the PyLint extension for VSCode or PyLint plugin for JetBrains products like Pycharm. The rules are saved in the .pylintrc files.