Skip to content

Commit

Permalink
feat: ehanced README
Browse files Browse the repository at this point in the history
  • Loading branch information
@UnMars
UnMars committed Aug 2, 2024
1 parent 866be31 commit 1242099
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,47 @@
<p align="center"><img width="200" src="https://github.com/UnMars/Prolific-Joiner/blob/main/media/Prolific_logo.png" alt="Prolific Logo"></p>
<p align="center"><img width="200" src="media/Prolific_logo.png" alt="Prolific Logo"></p>
<h1 align="center">Prolific Joiner</h1>


Inspired from [@shiflux](https://github.com/shiflux/prolific-updater)'s one.

## Installation

```sh
git clone https://github.com/UnMars/Prolific-Joiner
```

## Requirements

```sh
pip install -r requirements.txt
```

## Usage

```sh
python main.py
```

## Configuration

Edit the config.json file.

|Config|Usage|
| :------------: | :------------: |
|auto_renew_bearer|"True" or "False" *(default True)*|
|pause_on_idle|"True" or "False" *(default True)*|
|mail|Your mail on Prolific *(used to renew token)*|
|password|Your password on Prolific *(used to renew token)*|
|Prolific_ID|Your Prolific ID|
| Config | Usage |
| :---------------: | :----------------------------------------------------------------------------------: |
| auto_renew_bearer | "True" or "False" _(default True)_ |
| pause_on_idle | "True" or "False" _(default True)_ |
| mail | Your mail on Prolific _(used to renew token)_ |
| password | Your password on Prolific _(used to renew token)_ |
| Prolific_ID | Your Prolific ID |
| wait_time | Seconds between each check for a new study <br>(>10s should be okay) _(default 30s)_ |

## Known Error Code

|Error Code|Details|Meaning
| :------------: | :------------: | :------------: |
|140010|PEC-SUB-0002: We are sorry but we could not create your submission at this time. This may be due to your current network connection. For more information please see our <a href="https://participant-help.prolific.co/hc/en-gb/articles/360012393100-PEC-Error">help centre article</a>.|https://participant-help.prolific.co/hc/en-gb/articles/360012393100-PEC-Error#heading-0 <br /> **The IP address that you are using was flagged for suspicious behaviour** </br> Either wait for it to resolve by itself or make a ticket to Prolific Support. <br /> *(Try also to raise sleep duration)*


| Error Code | Details | Meaning |
| :--------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| 140010 | PEC-SUB-0002: We are sorry but we could not create your submission at this time. This may be due to your current network connection. For more information please see our <a href="https://participant-help.prolific.co/hc/en-gb/articles/360012393100-PEC-Error">help centre article</a>. | https://participant-help.prolific.co/hc/en-gb/articles/360012393100-PEC-Error#heading-0 <br /> **The IP address that you are using was flagged for suspicious behaviour** </br> Either wait for it to resolve by itself or make a ticket to Prolific Support. <br /> _(Try also to raise sleep duration)_ |

## Features

- Auto joining new study, generate a notification and open a new tab for it
- Almost all requests based (except for the token renewal)
- ReCaptcha Bypass
Expand Down

0 comments on commit 1242099

Please sign in to comment.