README.md

A minimalist app that prevents your computer from going to sleep.

Table of Contents

1. Prerequisites
2. Clone the Repository
3. Run the Code
4. Additional Tools

Prerequisites

• Python (latest version)
  • If using windows, in the python installer make sure to select the "Add Python to PATH" option
• Pycharm (optional)

Clone the Repository

Option 1: via Command Line Interface

• Install GitHub CLI (if not already installed)

  git clone https://github.com/trevtravtrev/StayAwake
  

Option 2: via GitHub Desktop

1. Install GitHub Desktop (if not already installed)
2. Follow instructions here to clone

Run the Code

Option 1: Poetry (Recommended for StayAwake)

1. Install Poetry (if not already installed)

pip install poetry

2. Install StayAwake dependencies

cd StayAwake
poetry install

3. Run StayAwake

poetry run python main.py

Option 2: requirements.txt

1. Create the virtual environment:

cd StayAwake
python -m venv venv

2. Activate the virtual environment:

• For Windows:

venv\Scripts\activate

• For macOS/Linux:

source venv/bin/activate

Once activated, you will notice that the prompt in your terminal or command prompt changes to indicate that you are now working within the virtual environment.
3. Install StayAwake dependencies

pip install -r requirements.txt

4. Run StayAwake

python main.py

Additional Tools

All StayAwake code was formatted, linted, and secured with the following tools:

• black
• flake8
• radon
• bandit
• isort
• mypy