Skip to main content

A bot for the away from keyboard times

Project description

build 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.8 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 🚀🌙 .

❓ 🆘 📲 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.2.0rc0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

afk_bot-0.2.0rc0-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file afk_bot-0.2.0rc0.tar.gz.

File metadata

  • Download URL: afk_bot-0.2.0rc0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Darwin/23.5.0

File hashes

Hashes for afk_bot-0.2.0rc0.tar.gz
Algorithm Hash digest
SHA256 ce07e63c0d4b4e7122a4cd0f2abc8a744215e10bc9e38ec5ed3cbd31db4d5048
MD5 49b1a7295c09c5a378688c9a4624b931
BLAKE2b-256 dc716a1a6ac0899e95a5de985ea24f68e888782fab9b635ab9b413ee03cd2a7d

See more details on using hashes here.

File details

Details for the file afk_bot-0.2.0rc0-py3-none-any.whl.

File metadata

  • Download URL: afk_bot-0.2.0rc0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Darwin/23.5.0

File hashes

Hashes for afk_bot-0.2.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 c9cab9f9dde2b26cbddfa3c06e860813ba746f088d863ee653e6b01d3e76531d
MD5 76d5a1cdc952c2b5a96dcbd06d19d9a3
BLAKE2b-256 f06d8fb40456ce0a5dd168bc3ccba84d3f850515ebaa94572b5e6e9a729e7432

See more details on using hashes here.

Supported by

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