A python habit tracker command-line application that uses questionary for a better UX and SQLite as database.
The habit tracker provides users with a simple easy tool that can be run on any platform that has access to python 3. For compatibility reasons and keeping the appliciation lightweight the choice was made to serve it within the command-line interface which is even available on operating systems that do not have a graphical user interface.
Users can easily track their habits by creating or logging in to their own user-profile and then proceed to create, manage and view their habits in an organized and accessible manner. In this way it is easy to keep track of personal progress with the use of analytics that show habit streaks, best performing and worst performing, and more.
28 September 2022: Removed functionality for email push notifications, for the scope of the project it would require daemon process to keep running in background to check if certain dates are already met and then send the push notifications. This however is no longer supported and can be considered removed.
25 October 2022: Added Checkin to User screen for easier access of checkin in to habits.
5 November 2022: Remove style attribute.
Python 3.7+
git clone https://github.com/DeusNexus/habit-tracker.git
cd habit-tracker
pip3 install -r requirements.txt
python3 main.py
rm Database/app.db
python -m pytest
After the application is started from the command-line the welcome screen will greet the user with total amount of registered users, datetime and general title screen. Options will be given of what the user can do next, which include creating a new user if someone doesn't yet have an account or logging in to one of the already registered users using the correct password.
The new user will be asked to provide a unique username and password for his account.
Choosing one of the registered users will ask you to provide the password. One can try again if it was wrong or choose to exit.
After successfull authentication the (new) user will be brought to the user screen which displays the current amount of active and inactive habits for the user, the next earliest deadline for all active habits and a wide variety of options including; View, Checkin, Create, Edit, Delete, Export/Import, Reset, Credits and Logou.
In the view screen one can display all habits, individual habits or filter by certain criteria for more specific grouping/matching. All Habits displays the active habits and general information like deadlines and streak, when the user selects Global Statistics a more detailed overview for all habits will be given with various statistics. The option Individual Habit will show only the given habit with more detail and additionally one can view checkins notes and rating when selecting the option Detailed Summary Statistics. Filter criteria offers the ability to filter habits based on user input or selection options. Interval can filter all habits for certain interval like 1D or 1W. Difficulity and Importance give option to select from 1 to 5 and show the resulting habits. Category receives case-sensitive pre-defined habit category (which can always be set using the edit screen) and shows all habits for that category, e.g. sport or education. Finally one can filter based on comparison operator (>,>=,=,<=,<>) and numeric value for streak, success, fail, cost and cost_accum.
In the checkin screen the user can checkin to their active habits, whether regular or dynamic, and will be shown a new deadline when successfully completing their goal. If deadline is overdue a new deadline will be given in the future and their habit streak will reset. For dynamic habits user has to checkin number of times specified before the given deadline to complete a dynamic habit streak.
Creating habits is easily done in the create screen. The user selects whether a regular or dynamic habit has to be created and step-wise is asked to provide mandatory information and/or can optionally add other features if desired.
In case one wants to change features of a Habit like title, description, interval, etc. then this can be done in the edit screen. A habit is simply selected from a list of all active and inactive habits and then the feature to be changed is selected and a new value is provided by the user.
The delete screen offers functionality to remove a habit by selecting it from the list. After selecting the habit it will be permanently deleted from the user account.
One can also choose to export the user account and this will generate a JSON file containing the user data. The data can be imported again on another device using the Habit Tracker application and choosing import. Now the user has to select the JSON file, which ideally is located in the same folder as the Habit Tracker and also provide the user password to decrypt the account. The account will then be added to the local user accounts and can be logged in to with all history of habits and checkins.
The option to completely or partially reset the user account is possible. Complete reset will do a clean slate wipe and leave nothing behind. Partial reset will clean everything and then load example data into the user account.
Feeling interested in who created the Habit Tracker application? See the credits and enjoy.
The application will log the user out and return to the login screen, while reloading all the data from the database.
The developed application is licensed under the GNU General Public License.