ohtuminiprojekti

Group: Fast Fishes

Table of Contents

• ohtuminiprojekti
• Table of Contents
  • Definition of Done:
  • Installing and Running the Program
    • Download
    • Installation
    • Running the Program
  • Backlog
  • Codecov
  • File Storage and Export Details
    • Location of Stored References
    • Exporting References
  • Retrospective Results
  • License
  • Final Report

Definition of Done:

• Functionality has been implemented
• Functionality has been tested
• Functionality has been integrated into the rest of the program

Installing and Running the Program

Download

Run the following command in the terminal:

git clone [email protected]:juhanikat/ohtuminiprojekti.git

Installation

Install the dependencies by running the following command in the terminal:

poetry install

Running the Program

Run the program with the command:

poetry run python3 src/index.py

At the start of execution, the program automatically loads the data from the data.json file. When the program is running, you can use it via terminal UI. The use options are the following:

• Input a to add a new reference
  • The program asks for inputs for the reference and saves it in the reference manager
• Input l to view references
  • The program prints all references in the reference manager
• Input r to remove a reference
  • The program deletes a reference from the reference manager
• Input e to export references
  • The program exports all references in the reference manager to a BibTeX file
• Input s to search references
  • User can input various parameters to limit the viewed references
• Input q to quit the program
  • The program saves the reference manager to data.json and quits.

Backlog

https://docs.google.com/spreadsheets/d/1t6cWLe60YoNf533Mlu33QweL5PVB-RmYKTP6vHFyb5Q/edit?usp=sharing

Codecov

https://app.codecov.io/gh/juhanikat/ohtuminiprojekti

File Storage and Export Details

Location of Stored References

All inputted references are stored in a JSON file for easy access and management. You can find this file at: src/repositories/data.json

Exporting References

Exported BibTeX files are stored in the following directory: src/exports/bibtex_export.bib

Retrospective Results

Results of retrospectives can be found in the RETRO. The results are in Finnish.

License

This project is licensed under the MIT License - see the LICENSE

Final Report

Final report can be found here: RAPORTTI