https://github.com/supersjgk/pyoverleafbot

Overleaf Bot to Appear Active
https://github.com/supersjgk/pyoverleafbot

overleaf python selenium selenium-python

Last synced: about 2 months ago
JSON representation

Overleaf Bot to Appear Active

• Host: GitHub
• URL: https://github.com/supersjgk/pyoverleafbot
• Owner: supersjgk
• Created: 2024-08-29T21:23:26.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-09-06T05:40:45.000Z (4 months ago)
• Last Synced: 2024-10-12T18:22:19.269Z (3 months ago)
• Topics: overleaf, python, selenium, selenium-python
• Language: Python
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Overleaf Automation Bot to Appear Active (pyoverleafbot)

### Overview

pyoverleafbot is built to help users appear active on collaborative Overleaf projects. It automates interactions with Overleaf.

### Tech Stack

- Python

- Selenium

### What can this be used for?

- **For PhD Students:** Helps manage stress

- **Coffee Break:** Set up the bot to run during breaks to keep your presence active.

- **Scheduled Runs:** Schedule the bot to run at specific times to maintain activity on projects.

### Why use Selenium rather than simple pyautogui?

- Selenium is an automation tool

- Selenium can interact directly with web applications in any browser

- Selenium provides high level interaction with the web elements

- Selenium can be used for web scraping

- Selenium scripts can be used in Headless Mode

### Implementations

- Platforms:

    - [x] Windows (Currently only implemented for Windows OS)

        - Robust Login:

            - [x] Windows Credential Manager (using email & password) + Store session information for faster login

            - [ ] Gmail login

        - Browsers:

            - [x] Chrome

            - [ ] Others

        - Scheduling (in progress):

            - [ ] Scheduled Runs when power on (logged in/logged out)

            - [ ] Scheduled Runs when power off

        - Functionalities:

            - [x] Fully automated

            - [x] Manage credentials securely

            - [x] Select project you want to work on

            - [x] Appear active

            - [x] Headless Mode

    - [ ] Linux (in progress)

    - [ ] Mac (in progress)

### One time setup

- Prerequisites: Windows with Python and Chrome browser installed.

- Clone the repository: `git clone https://github.com/supersjgk/pyoverleafbot`

- `cd pyoverleafbot`

- Install the dependencies: `pip install -r requirements.txt`

- `cd pyoverleafbot`

- Set Credentials in Windows Credential Manager by running: `python credential_manager.py set OverleafBot`

- Run the script: 

    - The Bot displays the available overleaf projects and prompts you to select a project: `python script.py`

    - To run the script in headless mode (Uses less resources, Browser GUI will not be displayed, the script still runs normally), use argument: `--headless 1`

    - If you already know the Overleaf Project ID: `python script.py --project_id `

    - If you want to appear active for x minutes (default 5 minutes), use the argument `--duration `

    - The bot repeatedly selects a random line (every 5 to 10 seconds) in the project to appear active. To override default values, use the arguments: `--min_change_time  --max_change_time `. It is recommended to set them to atleast 45 and 60, respectively to make it look more natural.

### Something not working?

- Please create Issue in [Github Repository](https://github.com/supersjgk/pyoverleafbot/issues)