Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 5.47 KB

README.md

File metadata and controls

108 lines (76 loc) · 5.47 KB
Raw

Project: HabitTracker

Table of Contents

  1. General Info
  2. Installation
  3. Usage and Main Functionalities
  4. Contributing

General Info

This HabitTracker helps you to keep track of activities you choose to track. The program was developed as part of a university project (B.Sc. Data Science). The task was to build a basic Python backend for a habit tracking app.

The app enables you to integrate positive, mindful habits in your daily life and receive a positive affirmation by completing habit streaks. The habits are assigned to the predefined categories "health", "mindfulness", and "fun". You can create a user profile, select habits from a predefined list as well as create your own habits. You are able to not only track your activities but also see what your current and longest streaks are.

Installation

Requirements: Make sure you have Python 3.7+ installed on your computer. You can download the latest version of Python here.

Req. Package:

Req. Package to run the tests:

  • freezegun (install via "pip install freezegun")
  • pytest (install via "pip install -U pytest")

How To:
After you've successfully installed Python, open your Mac, Windows or Linux Terminal. Now you have to install questionary. To do so, type "pip install questionary" into the console. The package will install itself. After you've installed questionary, you can start running the program. Download the files "Habit.py", "initialisation.py", "main.py" and "User.py" and save them in a folder on your computer. Now type the following - replace the placeholders with your personal file path - into your Terminal: "Python filepath/foldername/main.py". You've successfully launched the program! Have fun!

You are free to additionally download the "main_db.db" or the test data to try out some of the functionalities. For test usage please refer to the available data in the "data" folder or download the given main_db.db file.

To run the tests, download all files incl. the folder "test" onto your computer. Install freezegun with "pip install freezegun". Start the tests with calling pytest from the command-line "pytest filepath/foldername/test_NAME.py" - again, replace the placeholders with the file path on your computer.

Usage and Main Functionalities

For test usage please refer to the available data in the "data" folder or download the given main_db.db file.

Access documentation through Python's built-in help() function to get more information on the functionalities of the program.

0. Register

  • Possibility to create a user profile.
  • You are prompted to enter your first and last name, your preferred username and password.
  • If the username is already taken, you are prompted for a new one.
  • If everything is filled out correctly, your profile is created and you can login to the program.

1. Login

  • Enter your username and password to login.
  • If you are a new user and haven't saved any habits yet, you are prompted to choose your habits from a predefined list.
  • You can either choose to select or skip a habit with Y/N.

2. Edit User Profile

  • You can edit your first and last name as well as your password.

3. Create, Change or Mark a Habit as completed

3.1. Create a new habit
  • You are able to create your own habits.
  • To do so, you are prompted for a habit name, its category (Health, Fun, or Mindfulnes) and its periodicity (daily/weekly).
3.2. Delete a habit
  • To delete a habit, type in the name of the habit you want to delete.
3.3. Change an existing habit
  • To change an existing habit, type in the name of the habit you want to change.
  • You can change a habit's category and periodicity. You cannot change a habits name.
3.4. Mark a habit as completed
  • To track your progress, you need to mark your habits as completed when you finished them.
  • To mark your progress, just type in the name of your habit.
  • You can mark a habit as completed any time.
  • If you save the progress multiple times per day it is only counted as a one-day-streak.

4. Activity Overview

4.1. All habits
  • Shows you a list of all your saved habits.
4.2. All weekly habits
  • Shows you a list of all your weekly habits.
4.3. All daily habits
  • Shows you a list of all your daily habits.

5. View Stats

5.1. Your current streak overview
  • Shows you a list of all your habits and their respective current streaks.
  • Displays all weekly and all daily habits.
5.2. Your current streak per habit
  • To see your current streak of a specific habit, you are prompted to type in the name of the habit you want to check.
5.3. Your longest streak per habit
  • You can also find out what your best / longest streak for a specific habit is.
  • Just type in the name of the habit to find out.
5.4. Your longest streak overview (by periodicity)
  • Tells you what your longest daily and longest weekly streak are among all your habits.

Contributing

This is my first Python project. Your comments, suggestions, and contributions are welcome. Please feel free to contribute pull requests or create issues for bugs and feature requests.