MindMold is a user-friendly command-line interface (CLI) application designed to help individuals cultivate and maintain beneficial habits. It simplifies the process of habit tracking, enabling users to create, monitor, and analyze their habits over time. With MindMold, users can easily manage their daily routines and work towards achieving their personal growth goals.
- Create Habits: Add new habits with names and periodicities.
- View Habits: See a list of all your habits and their details.
- Update Habits: Change the details of an existing habit.
- Complete Habits: Mark habits as completed and track your progress.
- Analyze Habits: Analyze your habits with comprehensive streak data.
- Predefined Demos: View demo analyses using predefined habits.
To install the app, you need Python installed on your machine. Verify it's installed on your system by running the below command in your terminal.
python --version
If not, download and install it from python.org. Then, you can install the required dependencies by running:
pip install -r requirements.txt
To start the application, navigate to the app directory in your terminal and run:
python main.py
You will be greeted with a welcome message and a main menu. Navigate through the options by entering the corresponding number for each action you want to perform. The app is interactive and will guide you through each step needed to manage your habits.
MindMold utilizes pytest for running its suite of tests to ensure functionality and reliability. Follow these steps to install pytest and run the tests:
pytest is a powerful testing framework for Python that makes it easy to write simple and scalable test cases. If you haven't already installed pytest, you can do so by running the following command in your terminal:
pip install pytest
This command installs pytest and any dependencies required to run your tests.
Once pytest is installed, you can run the tests for MindMold to ensure everything is working as expected. Navigate to the project directory in your terminal and run:
pytest .
This command searches for test files in your project directory, runs the tests, and reports the outcomes in the terminal.