search

Zimzozaur / focus-tui

Your Deep Focus Session Buddy.
MIT License
3 stars 0 forks source link

readme

Ruff PyPI-Server Pyversions License: MIT Downloads

FocusTUI: Your Deep Focus Session Buddy. (WIP)

Are you struggling to maintain focus in a world full of distractions?

Say hello to FocusTUI - the minimalist, distraction-free focus session tracker that works straight from your terminal, no internet required. FocusTUI empowers you to create and track customized focus sessions with a highly personalized touch, ensuring you stay on track with your work, studies, or creative projects.

Disclaimer: The image displayed represents a potential appearance and features of FocusTUI. Actual app appearance and functionality may vary. board_image

Key Features:

  1. Cross-Platform: Works seamlessly on every operating system and in any terminal. No matter where you are, FocusTUI is there to support your focus.
  2. Statistics from Historical Data (coming soon): Gain insights into your productivity with comprehensive statistics generated from your past focus sessions. Understand your patterns and optimize your workflow.
  3. Custom Focus Queues (coming soon): Create and manage your own focus queues, with sessions categorized and tailored to your needs. Whether it’s deep work, light tasks, or breaks, FocusTUI adjusts to you.
  4. Custom Themes (coming soon): Personalize your experience with custom themes. Choose the colors that help you stay focused, or design your own.
  5. Custom Sounds: Import your own alarms, ambient sounds, and other audio cues to create the perfect atmosphere for your focus sessions.

Needed Tools

For Windows:

  1. Python Installation:
    • If you don’t have it installed, download Python from the official website.
    • During installation, make sure to check the checkbox that says “Add Python to PATH”.
  2. Install Scoop:
    • Scoop is a command-line installer for Windows. If you don’t have it installed, follow the instructions on the Scoop official website.
  3. Install pipx: 
    scoop install pipx
pipx ensurepath

For macOS:

  1. Install Homebrew:
    • Homebrew is a package manager for macOS. If you don’t have it installed, follow the instructions on the Homebrew official website.
  2. Install pipx: 
    brew install pipx
pipx ensurepath

For Linux:

  1. Install pipx:
    • Install pipx using your package manager.

FocusTUI Installation (every OS)

Once you have pipx installed, you can easily install FocusTUI:

  1. Install FocusTUI: 
    pipx install focustui

Run the App

After installation, you can start FocusTUI by typing:

focustui

Note for macOS users: The first time you open the app, it may take up to 1 minute. I’m not sure why, but during this initial launch, the app creates folders, files, a database, and moves sounds to the app folder. This delay only happens on the first launch. Apologies for the inconvenience.