Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 3.08 KB

README.md

File metadata and controls

46 lines (31 loc) · 3.08 KB
Raw

Workout assistant

This is a documentation file for the Working Assistant project (workass). The document is describing set up, usage and components of the application.

Requirements

  • The project was developed using Python. In the development process Python version 3.10 was used. Make sure that you are using the same python version in order to avoid issues with usage of the application. This is also specified in Pipenv file.

  • A strict emphasis on the version dependencies was used in this project. Pipenv is used for version control. Make sure that pipenv is installed and configured on your machine. Pipenv comprises Pipfile that contains the list of dependencies and Pipfile.lock that contains the dependencies' version. This allows for easier tracking dependencies. If you are using PyCharm, consider reading documentation for Pipfile in PyCharm.

  • sqlite database is used in the application. Make sure you have installed sqlite cli for usage of the database.

Make sure environment variables are added to the system settings.

Set up

  • Pipenv shell command to enter a pipenv shell
  • pipenv install installation command

optional commands

  • pipenv install --deploy enforce pipenv.lock and install
  • pipenv install --system install dependencies to the system

Usage

  • In case if you are using PyCharm make sure you have added and configure Python interpreter by following documentation.
  • The starting point of the application is main.py file, that can be started using command python main.py.
  • Once the application start, a timer will go off and go for 1 minute. Once the time is up, count of reps and time of exercise are added to the database.

Review data in database

Several methods can be used to view the historical data.

  • Using sqlite cli, by typing in the terminal (make sure you are in the same folder as the database) command sqlite <DB-NAME>, that will allow to use SQL to make queries to the database.
  • Use the command python data_report.py or simply run the data_report.py in order to get historical data overview.
  • If you are using Pycharm you have the option of connecting ot the database, using the in-build Pycharm interface and use it to view, change and query for data. You can find interface in View -> Tool Window -> Database, there select Data Source Properties icon, and as described in the documentation connect the sqlite database.

Report

The final report, IKT213_Group_project_final.pdf is a thorough documentation of the project from start to completion, including challenges and solutions. It contain the following sections:

  • Introduction
  • Theoretical Background
  • System Design and Implementation
  • Results and Discussion
  • Conclusion and Future Work