<div align="center">
[](https://github.com/slickml/afk-bot/actions/workflows/ci.yml)
[](https://codecov.io/gh/slickml/afk-bot)
[](https://github.com/slickml/afk-bot/blob/master/LICENSE/)
[](https://pepy.tech/project/afk-bot)
[](https://www.slickml.com/slack-invite)
</div>
<p align="center">
<a href="https://github.com/slickml/afk-bot">
<img src="https://raw.githubusercontent.com/slickml/afk-bot/master/assets/logo.png" width="250"></img>
</a>
</p>
<div align="center">
<h1 align="center">AFK-Bot🤖: A bot for the away from keyboard times
</h1>
</div>
## 🧠 Philosophy
We strongly believe that all developers should have full access to their resources (i.e. `sudo` access or permission to deactivate screens saver, ...). `afk-bot` 🤖 is a simple bot that moves the mouse cursor (every 1 second by default and it can be customized); so, your status never goes `Idle` and your screen never gets locked 😂 ...
## 🛠 Installation
To begin with, you need to have a [Python version >=3.8](https://www.python.org) installed and to install the library
from [PyPI](https://pypi.org/project/afk-bot/) simply run 🏃♀️ :
```
$ pip install afk-bot
```
## 📌 Quick Start
`afk-bot` is a `command-line` based bot and you can simply run it in any `terminal` 🏃♀️ :
```
$ afk-bot <- runs the bot and the mouse cursor moves every 1 second by default
$ afk-bot -t <interval-range> <- you can customize the interval with -t or --time
$ afk-bot --help <- shows the options
```
To `exit`, simply press `CTRL+C` keys.
## 📣 Common Issues
- Mac users should note that the accessibility to `Apple Events Server (AEServer)` should be turned on. Simply follow the steps 🏃♀️ :
```
System Preferences > Security & Privacy > Choose Privacy Tab > Select Accessibility from Left Pane > Enable AEServer
```
- Some Linux users might need to export the environment variable `DISPLAY`. Simply run 🏃♀️ :
```
$ export DISPLAY=:0
```
## 🧑💻🤝 Contributing
If you think more features should be added, please open up an issue an. PRs are more than welcome 🙏 . You can find the details of the development process in our SlickML🧞 [Contributing](CONTRIBUTING.md) guidelines. We strongly believe that reading and following these guidelines will help us make the contribution process easy and effective for everyone involved 🚀🌙 .
## ❓ 🆘 📲 Need Help?
Please join our [Slack Channel](https://www.slickml.com/slack-invite) to interact directly with the core team and our small community. This is a good place to discuss your questions and ideas or in general ask for help 👨👩👧 👫 👨👩👦 .
Raw data
{
"_id": null,
"home_page": "https://www.slickml.com",
"name": "afk-bot",
"maintainer": "Amirhessam Tahmassebi",
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": "admin@slickml.com",
"keywords": "afk, afk-bot",
"author": "Amirhessam Tahmassebi",
"author_email": "admin@slickml.com",
"download_url": "https://files.pythonhosted.org/packages/91/08/1415fd05ff09c0c0959f2c3ba72bb910f9478192d338ea24c67ca65f96b3/afk_bot-0.2.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n[](https://github.com/slickml/afk-bot/actions/workflows/ci.yml)\n[](https://codecov.io/gh/slickml/afk-bot)\n[](https://github.com/slickml/afk-bot/blob/master/LICENSE/)\n[](https://pepy.tech/project/afk-bot)\n\n\n[](https://www.slickml.com/slack-invite)\n\n\n</div>\n<p align=\"center\">\n <a href=\"https://github.com/slickml/afk-bot\">\n <img src=\"https://raw.githubusercontent.com/slickml/afk-bot/master/assets/logo.png\" width=\"250\"></img>\n </a>\n</p>\n\n<div align=\"center\">\n<h1 align=\"center\">AFK-Bot\ud83e\udd16: A bot for the away from keyboard times\n</h1>\n</div>\n\n## \ud83e\udde0 Philosophy\nWe strongly believe that all developers should have full access to their resources (i.e. `sudo` access or permission to deactivate screens saver, ...). `afk-bot` \ud83e\udd16 is a simple bot that moves the mouse cursor (every 1 second by default and it can be customized); so, your status never goes `Idle` and your screen never gets locked \ud83d\ude02 ...\n\n\n## \ud83d\udee0 Installation\nTo begin with, you need to have a [Python version >=3.8](https://www.python.org) installed and to install the library\nfrom [PyPI](https://pypi.org/project/afk-bot/) simply run \ud83c\udfc3\u200d\u2640\ufe0f :\n```\n$ pip install afk-bot\n```\n\n## \ud83d\udccc Quick Start\n`afk-bot` is a `command-line` based bot and you can simply run it in any `terminal` \ud83c\udfc3\u200d\u2640\ufe0f :\n```\n$ afk-bot <- runs the bot and the mouse cursor moves every 1 second by default\n\n$ afk-bot -t <interval-range> <- you can customize the interval with -t or --time\n\n$ afk-bot --help <- shows the options \n```\nTo `exit`, simply press `CTRL+C` keys. \n\n## \ud83d\udce3 Common Issues\n - Mac users should note that the accessibility to `Apple Events Server (AEServer)` should be turned on. Simply follow the steps \ud83c\udfc3\u200d\u2640\ufe0f :\n ```\n System Preferences > Security & Privacy > Choose Privacy Tab > Select Accessibility from Left Pane > Enable AEServer\n ```\n - Some Linux users might need to export the environment variable `DISPLAY`. Simply run \ud83c\udfc3\u200d\u2640\ufe0f :\n ```\n $ export DISPLAY=:0\n ```\n## \ud83e\uddd1\u200d\ud83d\udcbb\ud83e\udd1d Contributing\nIf you think more features should be added, please open up an issue an. PRs are more than welcome \ud83d\ude4f . You can find the details of the development process in our SlickML\ud83e\uddde [Contributing](CONTRIBUTING.md) guidelines. We strongly believe that reading and following these guidelines will help us make the contribution process easy and effective for everyone involved \ud83d\ude80\ud83c\udf19 .\n\n\n\n## \u2753 \ud83c\udd98 \ud83d\udcf2 Need Help?\nPlease join our [Slack Channel](https://www.slickml.com/slack-invite) to interact directly with the core team and our small community. This is a good place to discuss your questions and ideas or in general ask for help \ud83d\udc68\u200d\ud83d\udc69\u200d\ud83d\udc67 \ud83d\udc6b \ud83d\udc68\u200d\ud83d\udc69\u200d\ud83d\udc66 .\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A bot for the away from keyboard times",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/slickml/afk-bot",
"Homepage": "https://www.slickml.com",
"Repository": "https://github.com/slickml/afk-bot"
},
"split_keywords": [
"afk",
" afk-bot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "905a4bed91cefb8b5eab3907ac773451cf33646bdec3f0cb81542c46d10ac102",
"md5": "bb64a7472eadad2fb1093ae2ee5bf41c",
"sha256": "55b756067df78406dd17f7108e92de6b35f664637b7e0be764e06f35fc5d1972"
},
"downloads": -1,
"filename": "afk_bot-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb64a7472eadad2fb1093ae2ee5bf41c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 7767,
"upload_time": "2024-07-20T18:10:03",
"upload_time_iso_8601": "2024-07-20T18:10:03.351139Z",
"url": "https://files.pythonhosted.org/packages/90/5a/4bed91cefb8b5eab3907ac773451cf33646bdec3f0cb81542c46d10ac102/afk_bot-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91081415fd05ff09c0c0959f2c3ba72bb910f9478192d338ea24c67ca65f96b3",
"md5": "a05d46dfd54fcb044237c4883701ba2a",
"sha256": "0e983df3b6865a3045ba06aaaff4b9b0c79f7fa7490f07b6bbc0ad79a2b329c0"
},
"downloads": -1,
"filename": "afk_bot-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a05d46dfd54fcb044237c4883701ba2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 5946,
"upload_time": "2024-07-20T18:10:04",
"upload_time_iso_8601": "2024-07-20T18:10:04.486207Z",
"url": "https://files.pythonhosted.org/packages/91/08/1415fd05ff09c0c0959f2c3ba72bb910f9478192d338ea24c67ca65f96b3/afk_bot-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-20 18:10:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "slickml",
"github_project": "afk-bot",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "afk-bot"
}
JSON
