{"id":23739490,"url":"https://github.com/NayamAmarshe/please","last_synced_at":"2025-09-04T15:30:57.083Z","repository":{"id":37313545,"uuid":"489037217","full_name":"NayamAmarshe/please","owner":"NayamAmarshe","description":"🙏 Please CLI - Minimalistic New Tab Page CLI Tool with a greeting, date and time, inspirational quotes and your personal tasks and to-do list","archived":false,"fork":false,"pushed_at":"2023-11-07T13:46:33.000Z","size":4479,"stargazers_count":583,"open_issues_count":13,"forks_count":25,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-12-29T16:14:42.431Z","etag":null,"topics":["bash","cli","command-line","gnome-terminal","inspiration","konsole","new","page","please","please-cli","python","shell","tab","task-list","tasks","terminal","tool"],"latest_commit_sha":null,"homepage":"","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/NayamAmarshe.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2022-05-05T15:56:04.000Z","updated_at":"2024-12-12T03:54:33.000Z","dependencies_parsed_at":"2024-11-21T22:17:33.395Z","dependency_job_id":null,"html_url":"https://github.com/NayamAmarshe/please","commit_stats":{"total_commits":111,"total_committers":11,"mean_commits":"10.090909090909092","dds":"0.29729729729729726","last_synced_commit":"390ecaeda5cad70b56f2b4ef64725c1d1a10a842"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NayamAmarshe%2Fplease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NayamAmarshe%2Fplease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NayamAmarshe%2Fplease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NayamAmarshe%2Fplease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NayamAmarshe","download_url":"https://codeload.github.com/NayamAmarshe/please/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231970931,"owners_count":18453925,"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":["bash","cli","command-line","gnome-terminal","inspiration","konsole","new","page","please","please-cli","python","shell","tab","task-list","tasks","terminal","tool"],"created_at":"2024-12-31T09:36:57.262Z","updated_at":"2024-12-31T09:38:16.908Z","avatar_url":"https://github.com/NayamAmarshe.png","language":"Python","readme":"\u003cdiv align=\"center\"\u003e\n\n**For updates, questions and more:**    \n\n\u003ca href=\"https://t.me/iamnayam\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/25067102/209297095-a3db856f-b760-40bb-a68e-f3a3086e18c7.png\" width=\"300px\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n\u003ch1 align=\"center\"\u003e🙏 Please - New Tab Page for your Terminal 🙏\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eGet a beautifully formatted minimalistic new tab page with a greeting, date and time, inspirational quotes, your personal tasks and to-do list everytime you open the terminal with Please CLI.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/25067102/173348894-09190c99-baff-477a-9b48-b4d3cff0f029.gif\"\u003e\u003c/img\u003e\u003c/center\u003e\n\n# [Version 0.3.1 is out now!](https://github.com/NayamAmarshe/please/releases/tag/0.3.1)\n### Upgrade with `pip3 install please-cli --upgrade`\n\n# 📖 Table of Contents\n\n- [🚀 Installation](#-installation)\n   - [1️⃣ Method 1](#method-1)\n   - [2️⃣ Method 2](#method-2)\n- [🚑 Troubleshooting](#-troubleshooting)\n- [👨‍💻 Commands](#-commands)\n- [🧰 Additional Optional Configuration](#-additional-optional-configuration)\n- [🚮 Uninstalling](#-uninstalling)\n- [❤ Credits](#-credits)\n\n# 🚀 Installation\n\n### Method 1:\n\n1. Make sure you have Python 3 installed on your computer.\n2. Open your terminal and paste the command below:\n\n   ```bash\n   pip install please-cli\n\n   # If you get an error about 'pip not found', just replace pip with pip3.\n   ```\n\n3. To run **please** everytime you open the terminal:\n\n   ```bash\n   # FOR BASH\n   echo 'please' \u003e\u003e ~/.bashrc\n\n   # FOR ZSH\n   echo 'please' \u003e\u003e ~/.zshrc\n   \n   # FOR FISH\n   set fish_greeting please\n   ```\n\n   Or if you prefer to run **please** once a day:\n\n   ```bash\n   # FOR BASH\n   echo 'please daily' \u003e\u003e ~/.bashrc\n\n   # FOR ZSH\n   echo 'please daily' \u003e\u003e ~/.zshrc\n   \n   # FOR FISH\n   set fish_greeting please daily\n   ```\n\n4. That's it! Check if `please` command works in your terminal.\n\n### Method 2:\n\n1. Go to the releases section.\n2. Download the latest release WHL file.\n3. Open terminal and paste the command below:\n\n   ```bash\n   pip install --user ~/Downloads/please_cli*\n\n   # If you get an error about 'pip not found', just replace pip with pip3.\n   ```\n\n   Change the path of the file if you downloaded it elsewhere.\n\n4. To run **please** everytime you open the terminal:\n\n   ```bash\n   # FOR BASH\n   echo 'please' \u003e\u003e ~/.bashrc\n\n   # FOR ZSH\n   echo 'please' \u003e\u003e ~/.zshrc\n   \n   # FOR FISH\n   set fish_greeting please\n   ```\n\n5. That's it! Check if `please` command works in your terminal.\n\n###### Having trouble with installation or have any ideas? Please create an issue ticket :)\n\n# 🚑 Troubleshooting\n\nGetting a `command not found: please` error? That means the Python modules installation folder is not in PATH.\nTo fix this:\n\n```bash\necho 'export PATH=\"$PATH:$HOME/.local/bin\"' \u003e\u003e ~/.bashrc\n```\nand restart the terminal.\n\n# 👨‍💻 Commands\n\nSome of these commands may not be in the latest release.\n```bash\n# Show time, quotes and tasks\nplease\n\n# Add a task\nplease add \"TASK NAME\"\n\n# Delete a task\nplease delete \u003cTASK NUMBER\u003e\n\n# Mark task as done\nplease do \u003cTASK NUMBER\u003e\n\n# Edit task name\nplease edit \u003cTASK NUMBER\u003e \u003cNEW NAME\u003e\n\n# Mark task as undone\nplease undo \u003cTASK NUMBER\u003e\n\n# Show tasks even if all tasks are marked as done\nplease showtasks\n\n# Move task to specified position\nplease move \u003cOLD NUMBER\u003e \u003cNEW NUMBER\u003e\n\n# Toggle Time between 24 hours and 12 hours format\nplease changetimeformat\n\n# Change your name\nplease callme \"NAME\"\n\n# Delete all done tasks\nplease clean\n\n# Reset all settings and tasks\nplease setup\n```\n\n# 🧰 Additional Optional Configuration\n\n![image](https://user-images.githubusercontent.com/25067102/184050404-15c787d5-4b2f-40c5-a2df-0b2892099f1a.png)\n\n## Remove Greeting in please's output\n\n1.Navigate to `~/.config/please`  \n2. Open config.json  \n3. Change `\"diable_greeting\": false` to `\"diable_greeting\": true` (All lowercase).\n\n## Remove Horizontal Line in please's output\n\n1.Navigate to `~/.config/please`  \n2. Open config.json  \n3. Change `\"diable_line\": false` to `\"diable_line\": true` (All lowercase).\n\n## Remove Quotes in please's output\n\n1.Navigate to `~/.config/please`  \n2. Open config.json  \n3. Change `\"diable_quotes\": false` to `\"diable_quotes\": true` (All lowercase).\n\n# 💻 Local Development\n\n1. To get started, first install poetry:\n\n```bash\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n\n2. Clone this project\n3. `cd` to the project directory and run virtual environment:\n\n```bash\npoetry shell\n\n# OR THIS, IF 'poetry shell' doesn't work\n\n. \"$(dirname $(poetry run which python))/activate\"\n```\n\n4. Install all dependencies:\n\n```bash\npoetry install\n```\n\n- `please` will be available to use as a command in the virtual environment after using `poetry install`.\n\n5. Finally, run the python script with:\n\n```bash\npython please/please.py\n```\n\n6. To build a WHL package:\n\n```bash\npoetry build\n```\n\n- The package will be generated in **dist** folder, you can then use pip to install the WHL file.\n\n7. **For Nayam:** Publish the package with:\n\n```\npoetry publish -u \u003cusername\u003e -p \u003cpassword\u003e\n```\n\n# 🚮 Uninstalling\n\nOpen your terminal and type:\n\n```bash\npip uninstall please-cli\n```\n\nand also edit your **.zshrc** or **.bashrc** file and remove the line that says `please` at the end of the file.\n\n# ♥ Credits\n\n- Thanks to @CodePleaseRun \u0026 @guedesfelipe for their contributions.\n- Thanks to @lukePeavey for the quotes.json file taken from quotable.io\n\n#\n\n\u003ch4 align=\"center\"\u003e Made by TGS963 and NayamAmarshe with ⌨ and 🖱 \u003c/h4\u003e\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNayamAmarshe%2Fplease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNayamAmarshe%2Fplease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNayamAmarshe%2Fplease/lists"}