With a recommendation library an user could save a different types of recommendations about books, videos, blogs, podcasts etc.
The project backlog can be found here.
The final report can be found here.
A story is considered to be done when:
- The requirements of the user story have been analysed
- The required functionalities have been planned
- The required functionalities have been written as code
- The code that was written is tested using automated testing
- The code is integrated into the rest of the software
- The functionality of the user story is brought into the production environment
- The test coverage is over 80 %
The application has been developed and tested with Python version 3.8.
Using the application requires Python version 3.8 (or newer) and Poetry installed on the system.
The dependencies must be installed before the first launch by typing a following command to terminal:
poetry installThe the application has to be built by typing a following command:
poetry run invoke buildThen the application can be launched by typing a following command:
poetry run python3 src/main.pyWhen the application launches, there are three choices:
- Add a recommendation
- Browse recommendations
- Delete a recommendation
- Edit a recommendation
- Quit
When adding a recommendation, first type the name of recommendation. Then choose the type of recommendation and finally confirm the information right.
When browsing a recommendations, choosing "Browse recommendations" prints all the recommendations saved in the application.
When deleting a recommendation, first enter the index number of the recommendation you want to delete. Then choose to delete it and confirm your choice.
When editing a recommendation, first enter the index number of the recommendation you want to edit. Then input the new details of the recommendation.
When willing to quit, choosing "Quit" shuts down the application.