OhtuTube

University of Helsinki Software Engineering mini-project, Agile practices, Autumn 2022

Application to keep the source references used in writing Kandi papers in order and in a suitable format for Kandi.

Project Backlog

Final report (in Finnish)

Releases

Release 1.0 - Sprint 1

Release 1.1 - Sprint 2

Release 1.2 - Sprint 3

Release 1.3 - Final release

Definition of Done

• Functionality is integrated to the rest of the software
• User story's acceptance criterias are tested by Robot framework
• Code is tested with automated tests
• Test Coverage is over 80% (UI excluded)
• CI-enviroment tests are passed
• Coding style follows best-pracites confirmed by pylint, score over 9

Installation

The application uses Poetry for dependency management, so it must be installed before running the application.

1. Install required dependencies with the command:

poetry install

2. Initialize the application with the command:

poetry run invoke build

3. And finally run the application with the command:

poetry run invoke start

Testing

Unit tests can be performed with the command:

poetry run invoke test

End-to-end tests can be performed with the command:

poetry run invoke robot

Test coverage

Test coverage report can be generated with the command:

poetry run invoke coverage-report

Importing and exporting references in bibtex form

Default path for importing and exporting bibtex file:

src/bibtex_data/references.bib

Configuration for filename and path can be found in:

src/bibtex_config.py