Skip to main content

build docs codecov license downloads pypi_version python_version slack_invite twitter_url

AFK-Bot🤖: A bot for the away from keyboard times

🧠 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.10 installed and to install the library from PyPI 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 guidelines. We strongly believe that reading and following these guidelines will help us make the contribution process easy and effective for everyone involved 🚀🌙 .

Special thanks to all of our amazing contributors 👇

Repobeats analytics image

❓ 🆘 📲 Need Help?

Please join our Slack Channel 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 👨‍👩‍👧 👫 👨‍👩‍👦 .

Metadata

Release files for afk-bot 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for afk-bot 0.4.0
File Size Uploaded
afk_bot-0.4.0.tar.gz 14.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for afk-bot 0.4.0
File Interpreter ABI Platform
afk_bot-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 21.5 kB

Release files / afk_bot-0.4.0.tar.gz

Download URL afk_bot-0.4.0.tar.gz
Size 14.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b3bef04a5b1aa5b612b811d3b709f38d788578f4238212afc43924c76089a8c2
BLAKE2b-256 checksum
How to use checksums
bb2257cd2df09cc4294734e9e98057d8f57762af4ec6f852fa59bb6495039613
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / afk_bot-0.4.0-py3-none-any.whl

Download URL afk_bot-0.4.0-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4dc082ba534eb631958762212d5c167b8ba7b4b3d5917cf8283b4fa9d4b317f2
BLAKE2b-256 checksum
How to use checksums
326697b54dd61aa5e4bcd9c45d8afe55da8fcc9429795eeae8458f718d9aa2ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page