Skip to content

How to contribute to this project

Jump to bottom
James Thompson edited this page Jun 17, 2024 · 2 revisions

Depending on your level of experience and how setup your computer is you will either have to start at Setting up your environment or Setting up project.

Then you can read the contributing section (however this hasnt been made yet).

Setting up your environment

This will help anyone setup and use this repo from scratch. This is a guide for Windows only (Tested on 11 but may work on 10). It is so that a complete lay person can get started and see this project working. I havent had time to create one for mac, and have assumed anyone using linux will probably not need this part of the guide.

If you know what you are doing you can skip to Setting up project

All of this will be done from powershell so you can open it by pressing the windows key and typing "powershell" then clicking on Windows Powershell.

This is all assumed to be done on Windows

Need to do

Setup scoop

Scoop is used to help manage your apps and software on your computer.

Installing scoop is easy, just copy and paste this into powershell:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

Setup Git

Git is a version control system. It is the defacto standard in the industry and is used to manage code and projects.

Install Git

scoop install git

Setting up git

You need to give Git your name and a email address:

Set your name with:

git config --global user.name "firstname lastname"

And email address with:

git config --global user.email "YOUR_EMAIL"

Pulling the repo

Make sure you are in your "home" direcoty with this command

cd ~

Lastly you need to clone the repo this will bring all the files here onto your computer:

git clone https://github.com/1jamesthompson1/TAIC-report-summary.git

Setup Python

Python is one of the programming languages used here to do the main work.

Install Python

scoop install python

Install pip

scoop install pip

Install poetry (Package and Dependency manager)

More instructions can be found here: https://python-poetry.org/docs/

But all you need to do is run

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Setup VSCODE

VScode is a IDE (Integrated Development Environment) that is used to write code and run it.

Up to date information is on there website: https://code.visualstudio.com/download

Install VSCODE

windows

scoop install vscode

Install Python extension

Open vscode and press ctrl+shift+x and search for python and install the first one.

Setting up project

This assumes that you have already cloned the repo. To set the project up you will need to do three things:

  • Setup poetry
  • Setup pre-commits
  • Get api keys

Setting up poetry and pre-commits

It can all be done with this:

poetry install
pre-commit install

Setup API keys

For this project you are going to need to havea few api keys. These should all by put in the .env file in the root directory. API keys needed:

  • OPENAI_API_KEY
  • VOYAGE_API_KEY
Clone this wiki locally