| Name | TerminalAlert JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | None |
| Summary | Command Completion Alerts—Stay Notified, Stay Productive! |
| upload_time | 2024-12-21 06:47:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 Emmanuel C. Jemeni Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
command
notifications
terminal
productivity
automation
success
execution
alerts
cli
multitasking
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
TerminalAlert
=============
|contributors| |forks| |stars| |issues| |license|
Command Completion Alerts—Stay Notified, Stay Productive!
`Explore the repo <https://github.com/Jemeni11/TerminalAlert>`_
Table of Contents
=================
* `Introduction`_
* `Features`_
* `Installation`_
* `Usage`_
* `Examples`_
* `Roadmap`_
* `Why did I build this?`_
* `Contributing`_
* `Wait a minute, who are you?`_
* `License`_
* `Changelog`_
Introduction
============
TerminalAlert is a command-line application that keeps you informed about the
completion of your terminal commands.
Once a command completes, TerminalAlert sends a desktop notification indicating whether it succeeded or failed.
Perfect for multitaskers, this tool helps you stay productive without
having to monitor the terminal constantly.
Features
--------
* **Command Completion Alerts**: Receive desktop notifications when your terminal commands finish executing.
* **Detailed Command Summary**: After execution, the terminal displays:
* ``Output``: Standard output (if any).
* ``Error``: Standard error (if any).
* ``Execution time``: The time taken in seconds.
* **Success & Failure Indicators**: Notifications clearly indicate whether the command succeeded or encountered errors.
* **Cross-Platform Support**: Works on Windows, macOS, and Linux.
.. note::
Some applications may output error messages to ``stderr`` even when they execute successfully. For example:
``terminalalert "git clone https://github.com/Jemeni11/TerminalAlert.git TADupl"``
May produce the following:
Output: None
Error: Cloning into 'TADupl'...
Execution time: 4.45 seconds
This behavior depends on how the specific application writes to ``stdout`` and ``stderr``.
.. warning::
This tool is only partially complete on Windows. When it sends notifications, it may not display
the icon next to the title. If you mute TerminalAlert notifications on Windows, you will be unable
to enable them again. This is a known Windows bug with a fix in progress.
Installation
============
From PyPI (Using PIP)
---------------------
::
pip install TerminalAlert
Usage
=====
TerminalAlert is easy to use. Simply pass the command you want to
execute as an argument, and you'll receive a desktop notification upon its completion.
*TerminalAlert does not save any of your commands.*
::
usage: terminalalert [-h] [-u] command
Command Completion Alerts—Stay Notified, Stay Productive!
positional arguments:
command The command to run.
options:
-h, --help show this help message and exit
-u, --update Check if a new version is available.
Examples
========
Hello World
-----------
::
terminalalert "echo 'Hello World!'"
Clone a repo
------------
::
terminalalert "git clone https://github.com/Jemeni11/TerminalAlert.git"
Check for an update
-------------------
::
terminalalert -u
Roadmap
=======
* [✓] Initial MVP with desktop notifications
* [ ] Fix Windows specific issues
See the `open issues <https://github.com/Jemeni11/TerminalAlert/issues>`_ for a full list of proposed features (and known
issues).
Why did I build this?
=====================
I was cloning a big git repo while coding. I didn't want to monitor it 24/7, so I minimized the terminal and continued
coding. To my surprise, when I checked after 10 minutes, the process had failed. My network connection was unreliable
that day (let's not name the ISP). I retried multiple times, and it failed multiple times. This experience inspired me
to create a tool that could notify me when a terminal command completes.
Contributing
============
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any
contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also
simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (``git checkout -b feature/AmazingFeature``)
3. Commit your Changes (``git commit -m 'Add some AmazingFeature'``)
4. Push to the Branch (``git push origin feature/AmazingFeature``)
5. Open a Pull Request
Wait a minute, who are you?
===========================
`TerminalAlert <https://github.com/Jemeni11/TerminalAlert>`_ was built by Emmanuel Jemeni, a Frontend Developer with a
passion for Python.
You can find me on various platforms:
* `LinkedIn <https://www.linkedin.com/in/emmanuel-jemeni/>`_
* `GitHub <https://github.com/Jemeni11>`_
* `Twitter <https://twitter.com/Jemeni11_>`_
If you'd like, you can support me on `GitHub Sponsors <https://github.com/sponsors/Jemeni11/>`_
or `Buy Me A Coffee <https://www.buymeacoffee.com/jemeni11>`_.
License
=======
`MIT License <https://github.com/Jemeni11/TerminalAlert/blob/main/LICENSE>`_.
Changelog
=========
`Changelog <https://github.com/Jemeni11/TerminalAlert/blob/main/CHANGELOG.md>`_
.. |contributors| image:: https://img.shields.io/github/contributors/Jemeni11/TerminalAlert.svg?style=for-the-badge
:target: https://github.com/Jemeni11/TerminalAlert/graphs/contributors
.. |forks| image:: https://img.shields.io/github/forks/Jemeni11/TerminalAlert.svg?style=for-the-badge
:target: https://github.com/Jemeni11/TerminalAlert/network/members
.. |stars| image:: https://img.shields.io/github/stars/Jemeni11/TerminalAlert.svg?style=for-the-badge
:target: https://github.com/Jemeni11/TerminalAlert/stargazers
.. |issues| image:: https://img.shields.io/github/issues/Jemeni11/TerminalAlert.svg?style=for-the-badge
:target: https://github.com/Jemeni11/TerminalAlert/issues
.. |license| image:: https://img.shields.io/github/license/Jemeni11/TerminalAlert.svg?style=for-the-badge
:target: https://github.com/Jemeni11/TerminalAlert/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "TerminalAlert",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Command, Notifications, Terminal, Productivity, Automation, Success, Execution, Alerts, CLI, Multitasking",
"author": null,
"author_email": "\"Emmanuel C. Jemeni\" <jemenichinonso11@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/33/6c/509db1fbbf4c3ab244cc9ec91c00483171a703653cee720efd8ed9d1dd2f/terminalalert-1.2.1.tar.gz",
"platform": null,
"description": "TerminalAlert\r\n=============\r\n\r\n|contributors| |forks| |stars| |issues| |license|\r\n\r\nCommand Completion Alerts\u2014Stay Notified, Stay Productive!\r\n\r\n`Explore the repo <https://github.com/Jemeni11/TerminalAlert>`_\r\n\r\nTable of Contents\r\n=================\r\n* `Introduction`_\r\n* `Features`_\r\n* `Installation`_\r\n* `Usage`_\r\n* `Examples`_\r\n* `Roadmap`_\r\n* `Why did I build this?`_\r\n* `Contributing`_\r\n* `Wait a minute, who are you?`_\r\n* `License`_\r\n* `Changelog`_\r\n\r\nIntroduction\r\n============\r\nTerminalAlert is a command-line application that keeps you informed about the\r\ncompletion of your terminal commands.\r\n\r\nOnce a command completes, TerminalAlert sends a desktop notification indicating whether it succeeded or failed.\r\n\r\nPerfect for multitaskers, this tool helps you stay productive without\r\nhaving to monitor the terminal constantly.\r\n\r\nFeatures\r\n--------\r\n* **Command Completion Alerts**: Receive desktop notifications when your terminal commands finish executing.\r\n* **Detailed Command Summary**: After execution, the terminal displays:\r\n * ``Output``: Standard output (if any).\r\n * ``Error``: Standard error (if any).\r\n * ``Execution time``: The time taken in seconds.\r\n* **Success & Failure Indicators**: Notifications clearly indicate whether the command succeeded or encountered errors.\r\n* **Cross-Platform Support**: Works on Windows, macOS, and Linux.\r\n\r\n.. note::\r\n Some applications may output error messages to ``stderr`` even when they execute successfully. For example:\r\n\r\n ``terminalalert \"git clone https://github.com/Jemeni11/TerminalAlert.git TADupl\"``\r\n\r\n May produce the following:\r\n\r\n Output: None\r\n\r\n Error: Cloning into 'TADupl'...\r\n\r\n Execution time: 4.45 seconds\r\n\r\n This behavior depends on how the specific application writes to ``stdout`` and ``stderr``.\r\n\r\n.. warning::\r\n This tool is only partially complete on Windows. When it sends notifications, it may not display\r\n the icon next to the title. If you mute TerminalAlert notifications on Windows, you will be unable\r\n to enable them again. This is a known Windows bug with a fix in progress.\r\n\r\nInstallation\r\n============\r\n\r\nFrom PyPI (Using PIP)\r\n---------------------\r\n::\r\n\r\n pip install TerminalAlert\r\n\r\n\r\nUsage\r\n=====\r\nTerminalAlert is easy to use. Simply pass the command you want to\r\nexecute as an argument, and you'll receive a desktop notification upon its completion.\r\n\r\n*TerminalAlert does not save any of your commands.*\r\n\r\n::\r\n\r\n usage: terminalalert [-h] [-u] command\r\n\r\n Command Completion Alerts\u2014Stay Notified, Stay Productive!\r\n\r\n positional arguments:\r\n command The command to run.\r\n\r\n options:\r\n -h, --help show this help message and exit\r\n -u, --update Check if a new version is available.\r\n\r\nExamples\r\n========\r\nHello World\r\n-----------\r\n::\r\n\r\n terminalalert \"echo 'Hello World!'\"\r\n\r\nClone a repo\r\n------------\r\n::\r\n\r\n terminalalert \"git clone https://github.com/Jemeni11/TerminalAlert.git\"\r\n\r\nCheck for an update\r\n-------------------\r\n::\r\n\r\n terminalalert -u\r\n\r\nRoadmap\r\n=======\r\n* [\u2713] Initial MVP with desktop notifications\r\n* [ ] Fix Windows specific issues\r\n\r\nSee the `open issues <https://github.com/Jemeni11/TerminalAlert/issues>`_ for a full list of proposed features (and known\r\nissues).\r\n\r\nWhy did I build this?\r\n=====================\r\nI was cloning a big git repo while coding. I didn't want to monitor it 24/7, so I minimized the terminal and continued\r\ncoding. To my surprise, when I checked after 10 minutes, the process had failed. My network connection was unreliable\r\nthat day (let's not name the ISP). I retried multiple times, and it failed multiple times. This experience inspired me\r\nto create a tool that could notify me when a terminal command completes.\r\n\r\nContributing\r\n============\r\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any\r\ncontributions you make are **greatly appreciated**.\r\n\r\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also\r\nsimply open an issue with the tag \"enhancement\".\r\nDon't forget to give the project a star! Thanks again!\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (``git checkout -b feature/AmazingFeature``)\r\n3. Commit your Changes (``git commit -m 'Add some AmazingFeature'``)\r\n4. Push to the Branch (``git push origin feature/AmazingFeature``)\r\n5. Open a Pull Request\r\n\r\nWait a minute, who are you?\r\n===========================\r\n`TerminalAlert <https://github.com/Jemeni11/TerminalAlert>`_ was built by Emmanuel Jemeni, a Frontend Developer with a\r\npassion for Python.\r\n\r\nYou can find me on various platforms:\r\n\r\n* `LinkedIn <https://www.linkedin.com/in/emmanuel-jemeni/>`_\r\n* `GitHub <https://github.com/Jemeni11>`_\r\n* `Twitter <https://twitter.com/Jemeni11_>`_\r\n\r\nIf you'd like, you can support me on `GitHub Sponsors <https://github.com/sponsors/Jemeni11/>`_\r\nor `Buy Me A Coffee <https://www.buymeacoffee.com/jemeni11>`_.\r\n\r\nLicense\r\n=======\r\n`MIT License <https://github.com/Jemeni11/TerminalAlert/blob/main/LICENSE>`_.\r\n\r\nChangelog\r\n=========\r\n`Changelog <https://github.com/Jemeni11/TerminalAlert/blob/main/CHANGELOG.md>`_\r\n\r\n.. |contributors| image:: https://img.shields.io/github/contributors/Jemeni11/TerminalAlert.svg?style=for-the-badge\r\n :target: https://github.com/Jemeni11/TerminalAlert/graphs/contributors\r\n\r\n.. |forks| image:: https://img.shields.io/github/forks/Jemeni11/TerminalAlert.svg?style=for-the-badge\r\n :target: https://github.com/Jemeni11/TerminalAlert/network/members\r\n\r\n.. |stars| image:: https://img.shields.io/github/stars/Jemeni11/TerminalAlert.svg?style=for-the-badge\r\n :target: https://github.com/Jemeni11/TerminalAlert/stargazers\r\n\r\n.. |issues| image:: https://img.shields.io/github/issues/Jemeni11/TerminalAlert.svg?style=for-the-badge\r\n :target: https://github.com/Jemeni11/TerminalAlert/issues\r\n\r\n.. |license| image:: https://img.shields.io/github/license/Jemeni11/TerminalAlert.svg?style=for-the-badge\r\n :target: https://github.com/Jemeni11/TerminalAlert/blob/main/LICENSE\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Emmanuel C. Jemeni Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Command Completion Alerts\u2014Stay Notified, Stay Productive!",
"version": "1.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/Jemeni11/TerminalAlert/issues",
"Changelog": "https://github.com/Jemeni11/TerminalAlert/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/Jemeni11/TerminalAlert"
},
"split_keywords": [
"command",
" notifications",
" terminal",
" productivity",
" automation",
" success",
" execution",
" alerts",
" cli",
" multitasking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3fa203ab6dfab3d8411bfd5cc60b7f957540adbacd10c3c61915b6b7a9754a8c",
"md5": "ca7ed0335c91601196c55bdb7b24e946",
"sha256": "624a20027bd5ef77f8f783b44d03c26f95c25caea235aa7fe51e4c8c09e7c9ea"
},
"downloads": -1,
"filename": "TerminalAlert-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca7ed0335c91601196c55bdb7b24e946",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 387358,
"upload_time": "2024-12-21T06:47:19",
"upload_time_iso_8601": "2024-12-21T06:47:19.772257Z",
"url": "https://files.pythonhosted.org/packages/3f/a2/03ab6dfab3d8411bfd5cc60b7f957540adbacd10c3c61915b6b7a9754a8c/TerminalAlert-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "336c509db1fbbf4c3ab244cc9ec91c00483171a703653cee720efd8ed9d1dd2f",
"md5": "418627c245f9c9d9ee3401b8d5a56ba8",
"sha256": "bf2870c99942e2e447d7922a595825a8be7166c012f8c3db47a3b051a429b35f"
},
"downloads": -1,
"filename": "terminalalert-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "418627c245f9c9d9ee3401b8d5a56ba8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 391908,
"upload_time": "2024-12-21T06:47:29",
"upload_time_iso_8601": "2024-12-21T06:47:29.830946Z",
"url": "https://files.pythonhosted.org/packages/33/6c/509db1fbbf4c3ab244cc9ec91c00483171a703653cee720efd8ed9d1dd2f/terminalalert-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 06:47:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Jemeni11",
"github_project": "TerminalAlert",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "terminalalert"
}
