{"id":21175696,"url":"https://github.com/moisentinel/flomo","last_synced_at":"2025-07-09T21:32:09.148Z","repository":{"id":242091412,"uuid":"808664289","full_name":"moiSentineL/flomo","owner":"moiSentineL","description":"A flowmodoro timer CLI for productivity enthusiasts","archived":false,"fork":false,"pushed_at":"2025-06-09T18:50:14.000Z","size":1191,"stargazers_count":12,"open_issues_count":15,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-09T19:41:16.593Z","etag":null,"topics":["cli","flomodoro","flowtime","hacktoberfest","pomodoro-technique","productivity","stopwatch","timer","tui"],"latest_commit_sha":null,"homepage":"http://flomo.nibirsan.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moiSentineL.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-31T14:44:58.000Z","updated_at":"2025-06-09T19:16:00.000Z","dependencies_parsed_at":"2024-06-02T14:28:55.136Z","dependency_job_id":"d8db57f2-76aa-451a-acdb-90450462718f","html_url":"https://github.com/moiSentineL/flomo","commit_stats":null,"previous_names":["moisentinel/flomo"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/moiSentineL/flomo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moiSentineL%2Fflomo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moiSentineL%2Fflomo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moiSentineL%2Fflomo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moiSentineL%2Fflomo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moiSentineL","download_url":"https://codeload.github.com/moiSentineL/flomo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moiSentineL%2Fflomo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264503949,"owners_count":23618762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","flomodoro","flowtime","hacktoberfest","pomodoro-technique","productivity","stopwatch","timer","tui"],"created_at":"2024-11-20T17:00:21.699Z","updated_at":"2025-07-09T21:32:09.140Z","avatar_url":"https://github.com/moiSentineL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/moiSentineL/flomo/main/docs/assets/flomo-logo.png\" width=\"300\" style=\"margin-right: 10px; vertical-align: middle\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/moiSentineL/flomo/main/docs/assets/flomo-new.gif\" width=\"400\" style=\"margin-right: 10px; vertical-align: middle\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/moiSentineL/flomo/main/docs/assets/flomo-track.gif\" width=\"400\" style=\"margin-right: 10px; vertical-align: middle\"\u003e\n\u003c/p\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/moiSentineL/flomo#-installation\"\u003eInstallation\u003c/a\u003e | \n  \u003ca href=\"https://github.com/moiSentineL/flomo#-getting-started\"\u003eGetting Started\u003c/a\u003e | \n  \u003ca href=\"https://github.com/moiSentineL/flomo/wiki\"\u003eWiki\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\" styles=\"padding-top: 1em\"\u003e\n\t  \u003cimg src=\"https://img.shields.io/pypi/v/flomodoro?style=flat-square\" alt=\"PyPI Version\"\u003e\n  \u003cimg src=\"https://github.com/moiSentineL/flomo/actions/workflows/publish.yml/badge.svg?style=plastic\" alt=\"Build Status\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/moiSentineL/flomo?style=flat-square\" alt=\"License\"\u003e\n  \u003cimg src=\"https://img.shields.io/pypi/dm/flomodoro?style=flat-square\" alt=\"Downloads\"\u003e\n  \u003cbr\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues/moiSentineL/flomo?style=flat-square\" alt=\"Issues\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/forks/moiSentineL/flomo?style=flat-square\" alt=\"Forks\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/moiSentineL/flomo?style=flat-square\" alt=\"Stars\"\u003e\n\u003c/div\u003e\n\n---\n\t\n`flomo` is a crossplatform TUI/CLI for using the Flowtime Technique, also known as the **Flowmodoro** Technique. It's a task execution helper, or in other words, a productivity booster! 🚀\n\n`flomo` allows you to work on tasks in a flow state, manage your work/break time, and track your sessions.\n\nBuilt with: [rich](https://github.com/Textualize/rich) \u0026 [blessed](https://github.com/jquast/blessed) (TUI), [click](https://click.palletsprojects.com/en/8.1.x/) (CLI), [notify-send](https://man.archlinux.org/man/notify-send.1) for Linux notifications, [playsound](https://github.com/TaylorSMarks/playsound) (Windows \u0026 Mac sound), [paplay](https://linux.die.net/man/1/paplay) (Linux sound), [sqlite3](https://www.sqlite.org) (database).\n\n## ✨ Features\n\n-   **Cross-Platform** 🌐\n-   Stopwatch for Flow and Timer for Breaks ⏱️ \n-   Session tracker (date, duration, tag, and session) 🗓️\n-   Session manager: easily manipulate the sessions via CLI ⚙️\n-   Customizable, Clean UI 🎨\n-   Notifications (Linux only, for now) 🔔\n-   Fairly easy-to-use, I suppose 🤔\n-   (Potential) productivity booster 💥\n\n## 🎉 Background\n\n`flomo` started as a Hackathon ([livestream](https://www.youtube.com/live/xyqQgPEozv0)) on June 6, 2024, with [@Jonak-Adipta-Kalita](https://github.com/Jonak-Adipta-Kalita) and [@AnubhavSC](https://github.com/AnubhavSC). We aimed to create a small project that was fun and could potentially help others. We're all productivity fanatics, and this project is _heavily_ inspired by [pomo](https://github.com/kevinschoon/pomo).\n\nHowever, two hours in, we realized it was harder than expected. We spent a lot of time debugging and refactoring. [Here](https://nibirsan.org/blog/p/the-hackathon-experience/) are our learnings from the Hackathon.\n\n## 🌟 Flow and Flowtime Technique\n\n[Mihaly Csikszentmihalyi](https://en.wikipedia.org/wiki/Mihaly_Csikszentmihalyi) was known for his work on **Flow Theory**. He describes \"flow\" as:\n\n\u003e \"A state of being in which people become so immersed in the joy of their work or activity 'that nothing else seems to matter.'\"\n\nAs developers, creators, and romantics, we often experience that state of \"flow.\" This \"flow\" can **vary**, sometimes increasing or decreasing.\n\nThis can be visualized with a graph:\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/moiSentineL/flomo/main/docs/assets/flow-graph.png\" width=\"400\"\u003e\n\u003c/p\u003e\n\nWe can take advantage of this by identifying the **right time** to take a break—when the \"flow\" is depleting. This is the Flowtime technique.\n\nIt works like this: **If you work for x minutes, take a break for x/5 minutes. Then, repeat.** ⏳\n\nThis requires a good deal of discipline, meaning you need at least some natural focus. If not, check out the [Pomodoro Technique](https://www.pomodorotechnique.com/)! 🍅\n\n## 🛠️ Installation\n\n### 📋 Pre-requisites\n\n-   🐍 [Python](https://www.python.org/) ≥ 3.12\n-   📦 [pip](https://pip.pypa.io/en/stable/installation/)\n-   🛠️ [GCC Compiler](https://gcc.gnu.org/) **if** installing from source.\n\n### 📦 Instructions\n\n#### Using PyPi package\n\n```bash\npip install flomodoro\n```\n\n_Note: If you're on Linux, ensure `/home/user/.local/bin` is in your `PATH`. [More info for Linux newbies](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/)_\n\n#### Installing from source\n\n```bash\ngit clone https://github.com/moiSentineL/flomo.git\ncd flomo\npip install -r requirements.txt\n\n# For Linux Users:\ngcc -fPIC -shared -o flomo/session_id.so flomo/session_id.c\n\n# For Windows Users:\ngcc -shared -o flomo/session_id.dll flomo/session_id.c\n\npip install -e .\n```\n\n## 🚀 Getting Started\n\nInitialize flomo by:\n\n```bash\nflomo init\n```\n\nStart a flow by:\n\n```bash\nflomo s\n```\n\nStart a flow with the tag `work` and the session name `math`:\n\n```bash\nflomo s -t work -n math\n```\n\n### Check the [wiki](https://github.com/moiSentineL/flomo/wiki) for more info 📚\n\n## 🛤️ Roadmap\n\n-   ✅ Add sound on timer/stopwatch start\n-   ✅ Notification (only Linux for now)\n-   ✅ Configure colors\n-   ✅ Track sessions\n-   ✅ Configure colors\n-   ✅ Skipping Break\n-   🟧 Chart Generation / Statistics\n\nCheck our [Kanban Board](https://github.com/users/moiSentineL/projects/2).\n\n## 🤝 How to Contribute\n\nWant to help? Great! Here's how:\n\n1. **Fork** this [repo](https://github.com/moiSentineL/flomo/fork).\n2. **Clone** it to your local machine.\n3. **Create a branch** for your changes.\n4. **Make your edits** and test them.\n5. **Commit and push** your changes.\n6. **[Open a pull request](https://github.com/moiSentineL/flomo/pulls)** to the `main` branch.\n\n_Note: if you're new to Git and Github, I suggest you read this [Intro to Git and GitHub for Beginners](https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners)._\n\nLet's collaborate! 🌟\n\n[^1]: Csikszentmihalyi, M. (1990). _Flow: The Psychology of Optimal Experience_. New York: Harper and Row. p. 15 [ISBN](\u003chttps://en.wikipedia.org/wiki/ISBN_(identifier)\u003e) [0-06-092043-2](https://en.wikipedia.org/wiki/Special:BookSources/0-06-092043-2).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoisentinel%2Fflomo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoisentinel%2Fflomo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoisentinel%2Fflomo/lists"}