Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 1.5 KB

README.md

File metadata and controls

78 lines (51 loc) · 1.5 KB

Time Capsule

Application to help you track important dates and milestones.

Setup Instructions

  1. Install Python
    Ensure Python is installed on your system. You can download it from python.org.

  2. Set Up a Virtual Environment
    Create a virtual environment with the command:

    python -m venv .venv
  3. Activate the Virtual Environment
    On Windows, activate the virtual environment with:

    .venv\Scripts\activate

    On Unix or MacOS, use:

    source .venv/bin/activate
  4. Update Pip
    Upgrade pip to the latest version:

    python -m pip install --upgrade pip
  5. Install Requirements
    Install the necessary dependencies:

    pip install -r requirements.txt
  6. Run the Application

    Start the application with:

    python src/main.py

Update requirements.txt

To update requirements.txt, run the following command from within the virtual environment:

pipdeptree --warn silence > requirements.txt

Update Dependencies

Dependencies can be updated using pur. Run the following command within the virtual environment:

pur

Build a Windows Executable

To build a Windows executable, run the following command from within the virtual environment:

python build_release.py

Attribution

Dose icons created by Pixel perfect - Flaticon