<p align="center">
<a href="#readme">
<img alt="HyperFocus logo" src="https://raw.githubusercontent.com/u8slvn/hyperfocus/main/docs/source/_static/logo.png">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/hyperfocus/"><img src="https://img.shields.io/pypi/v/hyperfocus.svg" alt="Pypi Version"></a>
<a href="https://pypi.org/project/hyperfocus/"><img src="https://img.shields.io/pypi/pyversions/hyperfocus" alt="Python Version"></a>
<a href="https://github.com/u8slvn/hyperfocus/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/u8slvn/hyperfocus/ci.yml?label=CI" alt="CI"></a>
<a href="https://hyperfocus.readthedocs.io/"><img alt="Read the Docs" src="https://img.shields.io/readthedocs/hyperfocus"></a>
<a href="https://coveralls.io/github/u8slvn/hyperfocus?branch=main"><img src="https://coveralls.io/repos/github/u8slvn/hyperfocus/badge.svg?branch=main" alt="Coverage Status"></a>
<a href="https://app.codacy.com/gh/u8slvn/hyperfocus/dashboard"><img src="https://img.shields.io/codacy/grade/01ddd5668dbf4fc09f20ef215d0eec0b" alt="Code Quality"></a>
<a href="https://pypi.org/project/hyperfocus/"><img src="https://img.shields.io/pypi/l/hyperfocus" alt="Project license"></a>
</p>
---
**HyperFocus** is a minimalist CLI daily tasks manager that helps you stay focused on your work by avoiding distractions.
## 📜 Philosophy
You won't anticipate more than your daily goal with **HyperFocus**. No tasks prepared for the next week or month. The workflow is designed around the idea that, on a daily basis, you will review each unfinished tasks from the past day and choose whether you want to add it to the daily tasks. You are then able to prepare all your tasks for the day and update them to follow your work. The intention is to avoid overwhelming yourself and focus only on what you have prepared to do, for you and only you.
## 🚀 Quickstart
### Installation
The library [pipx](https://pypa.github.io/pipx/) allows to install and run Python applications in isolated environments so it does not mess around with your local installed library versions by keeping your local machine clean even after an uninstallation.
```bash
pipx install hyperfocus
```
Test your installation:
```bash
hyf --version
```
### Initialization
In order to work properly, **HyperFocus** needs to initialize a database and a configuration file. Both are generated into your home directory, unless you specified another location.
```bash
hyf init
```
### Example Usage
Add a new task:
```bash
hyf add "Implement the new super feature"
```
Add a new task with details:
```bash
hyf add "Read the great article about Python" -d "https://python-article.com"
```
Follow your daily tasks:
```bash
hyf status
```
or:
```bash
hyf
```
Find more information about all the commands in the documentation: [hyperfocus.readthedocs.io](https://hyperfocus.readthedocs.io)
Raw data
{
"_id": null,
"home_page": "https://github.com/u8slvn/hyperfocus",
"name": "hyperfocus",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "cli, todo, todolist, todo-list, task-list, productivity",
"author": "u8slvn",
"author_email": "u8slvn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bb/6f/2b0e5e96af1b0282dbfa8b32c0f239b37fc895d2aa94e39b46ee6d0def2b/hyperfocus-1.0.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"#readme\">\n <img alt=\"HyperFocus logo\" src=\"https://raw.githubusercontent.com/u8slvn/hyperfocus/main/docs/source/_static/logo.png\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/hyperfocus/\"><img src=\"https://img.shields.io/pypi/v/hyperfocus.svg\" alt=\"Pypi Version\"></a>\n <a href=\"https://pypi.org/project/hyperfocus/\"><img src=\"https://img.shields.io/pypi/pyversions/hyperfocus\" alt=\"Python Version\"></a>\n <a href=\"https://github.com/u8slvn/hyperfocus/actions/workflows/ci.yml\"><img src=\"https://img.shields.io/github/actions/workflow/status/u8slvn/hyperfocus/ci.yml?label=CI\" alt=\"CI\"></a>\n <a href=\"https://hyperfocus.readthedocs.io/\"><img alt=\"Read the Docs\" src=\"https://img.shields.io/readthedocs/hyperfocus\"></a>\n <a href=\"https://coveralls.io/github/u8slvn/hyperfocus?branch=main\"><img src=\"https://coveralls.io/repos/github/u8slvn/hyperfocus/badge.svg?branch=main\" alt=\"Coverage Status\"></a>\n <a href=\"https://app.codacy.com/gh/u8slvn/hyperfocus/dashboard\"><img src=\"https://img.shields.io/codacy/grade/01ddd5668dbf4fc09f20ef215d0eec0b\" alt=\"Code Quality\"></a>\n <a href=\"https://pypi.org/project/hyperfocus/\"><img src=\"https://img.shields.io/pypi/l/hyperfocus\" alt=\"Project license\"></a>\n</p>\n\n---\n\n**HyperFocus** is a minimalist CLI daily tasks manager that helps you stay focused on your work by avoiding distractions.\n\n## \ud83d\udcdc Philosophy\n\nYou won't anticipate more than your daily goal with **HyperFocus**. No tasks prepared for the next week or month. The workflow is designed around the idea that, on a daily basis, you will review each unfinished tasks from the past day and choose whether you want to add it to the daily tasks. You are then able to prepare all your tasks for the day and update them to follow your work. The intention is to avoid overwhelming yourself and focus only on what you have prepared to do, for you and only you.\n\n## \ud83d\ude80 Quickstart\n\n### Installation\n\nThe library [pipx](https://pypa.github.io/pipx/) allows to install and run Python applications in isolated environments so it does not mess around with your local installed library versions by keeping your local machine clean even after an uninstallation.\n\n```bash\npipx install hyperfocus\n```\n\nTest your installation:\n\n```bash\nhyf --version\n```\n\n### Initialization\n\nIn order to work properly, **HyperFocus** needs to initialize a database and a configuration file. Both are generated into your home directory, unless you specified another location.\n\n```bash\nhyf init\n```\n\n### Example Usage\n\nAdd a new task:\n\n```bash\nhyf add \"Implement the new super feature\"\n```\n\nAdd a new task with details:\n\n```bash\nhyf add \"Read the great article about Python\" -d \"https://python-article.com\"\n```\n\nFollow your daily tasks:\n\n```bash\nhyf status\n```\n\nor:\n\n```bash\nhyf\n```\n\nFind more information about all the commands in the documentation: [hyperfocus.readthedocs.io](https://hyperfocus.readthedocs.io)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minimalist daily task manager.",
"version": "1.0.0",
"project_urls": {
"Changelog": "https://github.com/u8slvn/hyperfocus/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/u8slvn/hyperfocus",
"Repository": "https://github.com/u8slvn/hyperfocus"
},
"split_keywords": [
"cli",
" todo",
" todolist",
" todo-list",
" task-list",
" productivity"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f097daf98432a67c25ee43ba5d47f2e205d1e20e944461cf1d5adfaf1d13e7b",
"md5": "1a3f2999e0d53f3bf6c30756d8354aa3",
"sha256": "e855a2f101ebef081f17f2a51bd682c9a9b4161468c2131c47679dc744408f48"
},
"downloads": -1,
"filename": "hyperfocus-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a3f2999e0d53f3bf6c30756d8354aa3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 39069,
"upload_time": "2024-06-12T12:45:06",
"upload_time_iso_8601": "2024-06-12T12:45:06.525978Z",
"url": "https://files.pythonhosted.org/packages/8f/09/7daf98432a67c25ee43ba5d47f2e205d1e20e944461cf1d5adfaf1d13e7b/hyperfocus-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb6f2b0e5e96af1b0282dbfa8b32c0f239b37fc895d2aa94e39b46ee6d0def2b",
"md5": "51b87027623c874d99d176575cbd4002",
"sha256": "7f180fb83dddae81db4d5408706dd43f2db38eb38072f9a747bc830247575358"
},
"downloads": -1,
"filename": "hyperfocus-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "51b87027623c874d99d176575cbd4002",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 22887,
"upload_time": "2024-06-12T12:45:08",
"upload_time_iso_8601": "2024-06-12T12:45:08.026625Z",
"url": "https://files.pythonhosted.org/packages/bb/6f/2b0e5e96af1b0282dbfa8b32c0f239b37fc895d2aa94e39b46ee6d0def2b/hyperfocus-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 12:45:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "u8slvn",
"github_project": "hyperfocus",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "hyperfocus"
}
JSON
