codeowners

Score Received: 70%🎉

This was built for my Software Engineering Fundamentals Module (QAC020C125SS).

Prerequisites

• Python 3.10 + installed
• A GitHub Organisation.
• Personal Access Token for GitHub Organisation, with Read/Write access.
• GitHub Organisation has a .github repository.

Steps

1. Check Python Version

MacOS & Linux

python3 -V

Windows

python -V

2. Downlaod & update pip

MacOS & Linux

python3 -m ensurepip --upgrade

Windows

python -m ensurepip --upgrade

3. Clone this repository

git clone [email protected]:gabrielg2020/codeowners.git && cd codeowners

4. Setup Python Virtual Enviroment

MacOS & Linux

python3 -m venv .venv && source .venv/bin/activate

Windows

python -m venv C:\path\to\codeowners\.venv

C:\path\to\codeowners\.venv\Scripts\activate.bat

5. Install required packages

MacOS & Linux

pip3 install -r requirements.txt

Windows

pip install -r requirements.txt

6. Setup enviroment variables

MacOS & Linux

cp .env.dist .env && sed -i 's/tk/<REPLACE_ME_WITH_YOUR_TOKEN>/g' .env

Windows

copy .env.dist .env && powershell -Command "(Get-Content '.env') -replace 'tk','<REPLACE_ME_WITH_YOUR_TOKEN>' | Set-Content '.env'"

Optional: Setting up unit tests.

Clone testing repository

git clone [email protected]:codeowners-rfc-test/testing-repo.git

Run Pytest

pytest

Error highlighting

pytest -vv --code-highlighting=yes

Packages used

python-dotev

Loads variables in .env into run-time enviroment variables.

pytest & pytest-mock

Unit testing package and it's class mocking library.

logger

Improved info, warning and error logging.

PyGitHub

GitHub API v3 wrapper.

pylint

Python linting.