StudyTimer - Pomodoro Timer

English | Português

---

English

A minimalist Pomodoro timer built with Python and PySide6. To maximize screen space and reduce visual distractions, the UI automatically hides at the edge of the monitor during focus sessions. It includes manual controls to start, pause, resume, and stop sessions, alongside a built-in history log to track your study and break intervals. As the timer approaches zero, it reappears with a red visual warning, followed by an audio alert to mark the transition between cycles.

How to Execute

For Windows Users (Ready-to-use Executable)

1. Access the repository's Actions tab on GitHub.
2. Click on the most recent build with a green success icon.
3. Scroll down to the Artifacts section and download StudyTimer-Windows (.zip).
4. Extract the file to use StudyTimer.exe. The package also includes checksum.txt and a quick verification guide.

For Linux Users (Source Code)

1. Clone the repository or download the project, then open your terminal in the project folder: git clone https://github.com/RaphaelBocardi/StudyTimer.git cd StudyTimer

2. Install the required dependencies: pip install -r requirements.txt

3. Run the program in the background to keep your terminal free: python main.py &

---

Português

Um cronômetro Pomodoro minimalista desenvolvido com Python e PySide6. Para otimizar o espaço na tela e reduzir distrações, a interface se oculta automaticamente na margem do monitor durante o foco. Inclui controles manuais para iniciar, pausar, retomar e encerrar sessões, além de um histórico integrado para registrar os ciclos de estudo e pausa. Quando o tempo se aproxima do fim, a janela reaparece com um alerta visual em vermelho, seguido por um aviso sonoro marcando a transição entre os ciclos.

Como Executar

Para quem usa Windows (Executável Pronto)

1. Acesse a aba Actions no repositório do projeto no GitHub.
2. Clique no build mais recente que estiver com o ícone verde de sucesso.
3. Role a página até a seção Artifacts e baixe o arquivo StudyTimer-Windows (.zip).
4. Extraia o arquivo para usar o executável StudyTimer.exe. O pacote também inclui o checksum.txt e um guia rápido de verificação de hash.

Para quem usa Linux (Código-Fonte)

1. Clone o repositório ou baixe o projeto e abra o terminal na pasta dele: git clone https://github.com/RaphaelBocardi/StudyTimer.git cd StudyTimer

2. Instale as dependências necessárias executando: pip install -r requirements.txt

3. Inicie o programa em segundo plano para manter o terminal livre: python main.py &