Skip to main content

A bot for the away from keyboard times

Project description

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 👨‍👩‍👧 👫 👨‍👩‍👦 .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

afk_bot-0.4.0.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

afk_bot-0.4.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file afk_bot-0.4.0.tar.gz.

File metadata

  • Download URL: afk_bot-0.4.0.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for afk_bot-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b3bef04a5b1aa5b612b811d3b709f38d788578f4238212afc43924c76089a8c2
MD5 952b53dd2d06598b0da3d52f8cb1c11e
BLAKE2b-256 bb2257cd2df09cc4294734e9e98057d8f57762af4ec6f852fa59bb6495039613

See more details on using hashes here.

File details

Details for the file afk_bot-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: afk_bot-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for afk_bot-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4dc082ba534eb631958762212d5c167b8ba7b4b3d5917cf8283b4fa9d4b317f2
MD5 a20a7947c86e2e6e858af1c1949ac160
BLAKE2b-256 326697b54dd61aa5e4bcd9c45d8afe55da8fcc9429795eeae8458f718d9aa2ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page