https://github.com/developmenthf/catigorise
Tool for categorising CATI responses 🗃️
https://github.com/developmenthf/catigorise
Last synced: about 1 year ago
JSON representation
Tool for categorising CATI responses 🗃️
- Host: GitHub
- URL: https://github.com/developmenthf/catigorise
- Owner: DevelopmentHF
- Created: 2023-08-01T05:50:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-01T08:11:23.000Z (over 2 years ago)
- Last Synced: 2025-01-22T19:16:25.658Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 74.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CATIgorise 🗄️
A tool used to categorise CATI verbatim responses into a set list of categories.
Inputted data should be in `csv` format, and outputted data retains all input data into a new file with the `category` column edited.
## Usage
CATIgorise currently is based on the action of installing a new gas meter, but that is easily edited in the source code if needed.
To add another category, add it to the `prompt` **variable** in `main.py`.
You will also need your own API key from OpenAI, and a new file called `env.py` with the following line:
```python
APIKEY = "YOUR_KEY_HERE" # replace with your own generated key
```
> Note: The program is based on test data csv file with the format:
>
> id,response,score,category
>
> For actual use, update this to your actual format, but make sure the string component retains the name "response"
Make sure the inputted data filename is set correctly to your file name:
```python
with open("YOUR_FILE_NAME.csv")
```
To run the program, use the in-built IDE run button or execute it in the CLI as such:
#### MacOS
```shell
python3 main.py
```
#### Windows
```shell
python main.py
```
## Dependencies
Only the OpenAI library is needed, install with the following commands.
#### MacOS:
```shell
pip3 install openai
```
#### Windows:
```shell
pip install openai
```