ChaterJee 0.2.2__tar.gz → 0.2.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- chaterjee-0.2.4/ChaterJee.egg-info/PKG-INFO +96 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee.egg-info/SOURCES.txt +0 -1
- chaterjee-0.2.4/PKG-INFO +96 -0
- chaterjee-0.2.4/README.md +86 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/setup.py +1 -1
- chaterjee-0.2.2/ChaterJee/updater.py +0 -8
- chaterjee-0.2.2/ChaterJee.egg-info/PKG-INFO +0 -12
- chaterjee-0.2.2/PKG-INFO +0 -12
- chaterjee-0.2.2/README.md +0 -2
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee/ChaterJee.py +0 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee/__init__.py +0 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee.egg-info/dependency_links.txt +0 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee.egg-info/requires.txt +0 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/ChaterJee.egg-info/top_level.txt +0 -0
- {chaterjee-0.2.2 → chaterjee-0.2.4}/setup.cfg +0 -0
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: ChaterJee
|
|
3
|
+
Version: 0.2.4
|
|
4
|
+
Summary: Communicate your project updates via Telegram Bot!
|
|
5
|
+
Author: Pallab Dutta
|
|
6
|
+
Author-email: pallab9997@gmail.com
|
|
7
|
+
Requires-Python: >=3.8
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
Requires-Dist: python-telegram-bot==20.7
|
|
10
|
+
|
|
11
|
+
# ChaterJee
|
|
12
|
+
|
|
13
|
+
<img src="https://github.com/Pallab-Dutta/ChaterJee/blob/main/ChaterJee/ProfilePhoto.png" alt="ChaterJee" width="200"/>
|
|
14
|
+
|
|
15
|
+
Often, we need to run computational `trial and error` experiments by just tweaking one or two key parameters. In machine learning, you face similar problems during hyperparameter tuning experiments.
|
|
16
|
+
|
|
17
|
+
These are probably the most boring, time-consuming, yet unavoidable phases in our day-to-day research. But what if your experiments could keep working while you're at a date XD ? What if you could kick off a hyperparameter tuning run just before bed — and wake up with results and plots waiting on your phone, like a good morning message from your research? Real-time updates, one-tap reruns, and zero late-night debugging. It’s like having a research assistant in your pocket.
|
|
18
|
+
|
|
19
|
+
Let me introduce ChaterJee to you — a playful fusion of `Chater`, meaning one who chats, and `Jee`, an honorific used in Indian culture to show respect. Think of `ChaterJee` as the lab assistant you always wanted — one who actually responds, never crashes your code, doesn't ask for co-authorship, and definitely doesn't need coffee all the time, unlike you.
|
|
20
|
+
|
|
21
|
+
# Installation
|
|
22
|
+
You need two things:
|
|
23
|
+
1. The `ChaterJee` module
|
|
24
|
+
2. A telegram BOT that you own
|
|
25
|
+
|
|
26
|
+
## Installing the module
|
|
27
|
+
I recommend to install `ChaterJee` module inside your project's conda environment for a seamless experience.
|
|
28
|
+
```bash
|
|
29
|
+
conda activate yourenv
|
|
30
|
+
pip install ChaterJee
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Get your telegram BOT
|
|
34
|
+
To use this `ChaterJee`, you'll need a Telegram Bot Token and your Chat ID. Follow these simple steps:
|
|
35
|
+
|
|
36
|
+
### Create a Bot and Get the Token
|
|
37
|
+
- Open Telegram and search for **@BotFather**.
|
|
38
|
+
- Start a chat and send the command `/newbot`.
|
|
39
|
+
- Follow the prompts: choose a name and a username for your bot.
|
|
40
|
+
- Once done, **BotFather** will give you a **bot token** — a long string like `123456789:ABCdefGhiJKlmNoPQRsTuvWXyz`.
|
|
41
|
+
|
|
42
|
+
### Get Your Chat ID
|
|
43
|
+
- Open Telegram and start a chat with your newly created bot by searching its username.
|
|
44
|
+
- Send `Hi` (any message) to your bot.
|
|
45
|
+
- Open your browser and visit this URL, replacing `YOUR_BOT_TOKEN` with your token:
|
|
46
|
+
`
|
|
47
|
+
https://api.telegram.org/bot{YOUR_BOT_TOKEN}/getUpdates
|
|
48
|
+
`
|
|
49
|
+
|
|
50
|
+
with the above token, this URL becomes:
|
|
51
|
+
`
|
|
52
|
+
https://api.telegram.org/bot123456789:ABCdefGhiJKlmNoPQRsTuvWXyz/getUpdates
|
|
53
|
+
`
|
|
54
|
+
- Look for `"chat":{"id":...}` in the JSON response. This number is your **Chat ID**.
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Quick Start
|
|
58
|
+
`ChaterJee` has two components.
|
|
59
|
+
- `NoteLogs` class: This stores log files, and save project locations for parsing updates.
|
|
60
|
+
- `ChatLogs` class: This reads log files, the last line is sent to you via the BOT. It can also share you final plots that you need for your next rerun.
|
|
61
|
+
|
|
62
|
+
## The minimal example
|
|
63
|
+
This will register your JOB with the given `JOB_NAME` and logfiles into a JSON file, `<your home>/.data/JOB_status.json`.
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
# This is a minimal example
|
|
67
|
+
import ChaterJee
|
|
68
|
+
|
|
69
|
+
# your code here
|
|
70
|
+
JOB_NAME = "job_0.1.10"
|
|
71
|
+
OUT_NAME = "experiment_0.1"
|
|
72
|
+
|
|
73
|
+
for i in range(N):
|
|
74
|
+
# Your code here
|
|
75
|
+
notelogs = ChaterJee.NoteLogs()
|
|
76
|
+
notelogs.write(f"{JOB_NAME}",\
|
|
77
|
+
logSTRING=f"Step {i} done.",\
|
|
78
|
+
logFILE=f"{OUT_NAME}.log",\
|
|
79
|
+
logIMAGE=f"{OUT_NAME}.png")
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Next step is to receive updates on your projects.
|
|
83
|
+
|
|
84
|
+
```python
|
|
85
|
+
# Run this instance separately to parse job updates
|
|
86
|
+
# This is the one which actually communicates with your BOT.
|
|
87
|
+
|
|
88
|
+
import ChaterJee
|
|
89
|
+
|
|
90
|
+
if __name__ == '__main__':
|
|
91
|
+
TOKEN = '123456789:ABCdefGhiJKlmNoPQRsTuvWXyz'
|
|
92
|
+
CHATID = '123456789'
|
|
93
|
+
|
|
94
|
+
cbot = ChaterJee.ChatLogs(TOKEN, CHATID)
|
|
95
|
+
cbot.cmdTRIGGER()
|
|
96
|
+
```
|
chaterjee-0.2.4/PKG-INFO
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: ChaterJee
|
|
3
|
+
Version: 0.2.4
|
|
4
|
+
Summary: Communicate your project updates via Telegram Bot!
|
|
5
|
+
Author: Pallab Dutta
|
|
6
|
+
Author-email: pallab9997@gmail.com
|
|
7
|
+
Requires-Python: >=3.8
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
Requires-Dist: python-telegram-bot==20.7
|
|
10
|
+
|
|
11
|
+
# ChaterJee
|
|
12
|
+
|
|
13
|
+
<img src="https://github.com/Pallab-Dutta/ChaterJee/blob/main/ChaterJee/ProfilePhoto.png" alt="ChaterJee" width="200"/>
|
|
14
|
+
|
|
15
|
+
Often, we need to run computational `trial and error` experiments by just tweaking one or two key parameters. In machine learning, you face similar problems during hyperparameter tuning experiments.
|
|
16
|
+
|
|
17
|
+
These are probably the most boring, time-consuming, yet unavoidable phases in our day-to-day research. But what if your experiments could keep working while you're at a date XD ? What if you could kick off a hyperparameter tuning run just before bed — and wake up with results and plots waiting on your phone, like a good morning message from your research? Real-time updates, one-tap reruns, and zero late-night debugging. It’s like having a research assistant in your pocket.
|
|
18
|
+
|
|
19
|
+
Let me introduce ChaterJee to you — a playful fusion of `Chater`, meaning one who chats, and `Jee`, an honorific used in Indian culture to show respect. Think of `ChaterJee` as the lab assistant you always wanted — one who actually responds, never crashes your code, doesn't ask for co-authorship, and definitely doesn't need coffee all the time, unlike you.
|
|
20
|
+
|
|
21
|
+
# Installation
|
|
22
|
+
You need two things:
|
|
23
|
+
1. The `ChaterJee` module
|
|
24
|
+
2. A telegram BOT that you own
|
|
25
|
+
|
|
26
|
+
## Installing the module
|
|
27
|
+
I recommend to install `ChaterJee` module inside your project's conda environment for a seamless experience.
|
|
28
|
+
```bash
|
|
29
|
+
conda activate yourenv
|
|
30
|
+
pip install ChaterJee
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Get your telegram BOT
|
|
34
|
+
To use this `ChaterJee`, you'll need a Telegram Bot Token and your Chat ID. Follow these simple steps:
|
|
35
|
+
|
|
36
|
+
### Create a Bot and Get the Token
|
|
37
|
+
- Open Telegram and search for **@BotFather**.
|
|
38
|
+
- Start a chat and send the command `/newbot`.
|
|
39
|
+
- Follow the prompts: choose a name and a username for your bot.
|
|
40
|
+
- Once done, **BotFather** will give you a **bot token** — a long string like `123456789:ABCdefGhiJKlmNoPQRsTuvWXyz`.
|
|
41
|
+
|
|
42
|
+
### Get Your Chat ID
|
|
43
|
+
- Open Telegram and start a chat with your newly created bot by searching its username.
|
|
44
|
+
- Send `Hi` (any message) to your bot.
|
|
45
|
+
- Open your browser and visit this URL, replacing `YOUR_BOT_TOKEN` with your token:
|
|
46
|
+
`
|
|
47
|
+
https://api.telegram.org/bot{YOUR_BOT_TOKEN}/getUpdates
|
|
48
|
+
`
|
|
49
|
+
|
|
50
|
+
with the above token, this URL becomes:
|
|
51
|
+
`
|
|
52
|
+
https://api.telegram.org/bot123456789:ABCdefGhiJKlmNoPQRsTuvWXyz/getUpdates
|
|
53
|
+
`
|
|
54
|
+
- Look for `"chat":{"id":...}` in the JSON response. This number is your **Chat ID**.
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
# Quick Start
|
|
58
|
+
`ChaterJee` has two components.
|
|
59
|
+
- `NoteLogs` class: This stores log files, and save project locations for parsing updates.
|
|
60
|
+
- `ChatLogs` class: This reads log files, the last line is sent to you via the BOT. It can also share you final plots that you need for your next rerun.
|
|
61
|
+
|
|
62
|
+
## The minimal example
|
|
63
|
+
This will register your JOB with the given `JOB_NAME` and logfiles into a JSON file, `<your home>/.data/JOB_status.json`.
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
# This is a minimal example
|
|
67
|
+
import ChaterJee
|
|
68
|
+
|
|
69
|
+
# your code here
|
|
70
|
+
JOB_NAME = "job_0.1.10"
|
|
71
|
+
OUT_NAME = "experiment_0.1"
|
|
72
|
+
|
|
73
|
+
for i in range(N):
|
|
74
|
+
# Your code here
|
|
75
|
+
notelogs = ChaterJee.NoteLogs()
|
|
76
|
+
notelogs.write(f"{JOB_NAME}",\
|
|
77
|
+
logSTRING=f"Step {i} done.",\
|
|
78
|
+
logFILE=f"{OUT_NAME}.log",\
|
|
79
|
+
logIMAGE=f"{OUT_NAME}.png")
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Next step is to receive updates on your projects.
|
|
83
|
+
|
|
84
|
+
```python
|
|
85
|
+
# Run this instance separately to parse job updates
|
|
86
|
+
# This is the one which actually communicates with your BOT.
|
|
87
|
+
|
|
88
|
+
import ChaterJee
|
|
89
|
+
|
|
90
|
+
if __name__ == '__main__':
|
|
91
|
+
TOKEN = '123456789:ABCdefGhiJKlmNoPQRsTuvWXyz'
|
|
92
|
+
CHATID = '123456789'
|
|
93
|
+
|
|
94
|
+
cbot = ChaterJee.ChatLogs(TOKEN, CHATID)
|
|
95
|
+
cbot.cmdTRIGGER()
|
|
96
|
+
```
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# ChaterJee
|
|
2
|
+
|
|
3
|
+
<img src="https://github.com/Pallab-Dutta/ChaterJee/blob/main/ChaterJee/ProfilePhoto.png" alt="ChaterJee" width="200"/>
|
|
4
|
+
|
|
5
|
+
Often, we need to run computational `trial and error` experiments by just tweaking one or two key parameters. In machine learning, you face similar problems during hyperparameter tuning experiments.
|
|
6
|
+
|
|
7
|
+
These are probably the most boring, time-consuming, yet unavoidable phases in our day-to-day research. But what if your experiments could keep working while you're at a date XD ? What if you could kick off a hyperparameter tuning run just before bed — and wake up with results and plots waiting on your phone, like a good morning message from your research? Real-time updates, one-tap reruns, and zero late-night debugging. It’s like having a research assistant in your pocket.
|
|
8
|
+
|
|
9
|
+
Let me introduce ChaterJee to you — a playful fusion of `Chater`, meaning one who chats, and `Jee`, an honorific used in Indian culture to show respect. Think of `ChaterJee` as the lab assistant you always wanted — one who actually responds, never crashes your code, doesn't ask for co-authorship, and definitely doesn't need coffee all the time, unlike you.
|
|
10
|
+
|
|
11
|
+
# Installation
|
|
12
|
+
You need two things:
|
|
13
|
+
1. The `ChaterJee` module
|
|
14
|
+
2. A telegram BOT that you own
|
|
15
|
+
|
|
16
|
+
## Installing the module
|
|
17
|
+
I recommend to install `ChaterJee` module inside your project's conda environment for a seamless experience.
|
|
18
|
+
```bash
|
|
19
|
+
conda activate yourenv
|
|
20
|
+
pip install ChaterJee
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Get your telegram BOT
|
|
24
|
+
To use this `ChaterJee`, you'll need a Telegram Bot Token and your Chat ID. Follow these simple steps:
|
|
25
|
+
|
|
26
|
+
### Create a Bot and Get the Token
|
|
27
|
+
- Open Telegram and search for **@BotFather**.
|
|
28
|
+
- Start a chat and send the command `/newbot`.
|
|
29
|
+
- Follow the prompts: choose a name and a username for your bot.
|
|
30
|
+
- Once done, **BotFather** will give you a **bot token** — a long string like `123456789:ABCdefGhiJKlmNoPQRsTuvWXyz`.
|
|
31
|
+
|
|
32
|
+
### Get Your Chat ID
|
|
33
|
+
- Open Telegram and start a chat with your newly created bot by searching its username.
|
|
34
|
+
- Send `Hi` (any message) to your bot.
|
|
35
|
+
- Open your browser and visit this URL, replacing `YOUR_BOT_TOKEN` with your token:
|
|
36
|
+
`
|
|
37
|
+
https://api.telegram.org/bot{YOUR_BOT_TOKEN}/getUpdates
|
|
38
|
+
`
|
|
39
|
+
|
|
40
|
+
with the above token, this URL becomes:
|
|
41
|
+
`
|
|
42
|
+
https://api.telegram.org/bot123456789:ABCdefGhiJKlmNoPQRsTuvWXyz/getUpdates
|
|
43
|
+
`
|
|
44
|
+
- Look for `"chat":{"id":...}` in the JSON response. This number is your **Chat ID**.
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
# Quick Start
|
|
48
|
+
`ChaterJee` has two components.
|
|
49
|
+
- `NoteLogs` class: This stores log files, and save project locations for parsing updates.
|
|
50
|
+
- `ChatLogs` class: This reads log files, the last line is sent to you via the BOT. It can also share you final plots that you need for your next rerun.
|
|
51
|
+
|
|
52
|
+
## The minimal example
|
|
53
|
+
This will register your JOB with the given `JOB_NAME` and logfiles into a JSON file, `<your home>/.data/JOB_status.json`.
|
|
54
|
+
|
|
55
|
+
```python
|
|
56
|
+
# This is a minimal example
|
|
57
|
+
import ChaterJee
|
|
58
|
+
|
|
59
|
+
# your code here
|
|
60
|
+
JOB_NAME = "job_0.1.10"
|
|
61
|
+
OUT_NAME = "experiment_0.1"
|
|
62
|
+
|
|
63
|
+
for i in range(N):
|
|
64
|
+
# Your code here
|
|
65
|
+
notelogs = ChaterJee.NoteLogs()
|
|
66
|
+
notelogs.write(f"{JOB_NAME}",\
|
|
67
|
+
logSTRING=f"Step {i} done.",\
|
|
68
|
+
logFILE=f"{OUT_NAME}.log",\
|
|
69
|
+
logIMAGE=f"{OUT_NAME}.png")
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Next step is to receive updates on your projects.
|
|
73
|
+
|
|
74
|
+
```python
|
|
75
|
+
# Run this instance separately to parse job updates
|
|
76
|
+
# This is the one which actually communicates with your BOT.
|
|
77
|
+
|
|
78
|
+
import ChaterJee
|
|
79
|
+
|
|
80
|
+
if __name__ == '__main__':
|
|
81
|
+
TOKEN = '123456789:ABCdefGhiJKlmNoPQRsTuvWXyz'
|
|
82
|
+
CHATID = '123456789'
|
|
83
|
+
|
|
84
|
+
cbot = ChaterJee.ChatLogs(TOKEN, CHATID)
|
|
85
|
+
cbot.cmdTRIGGER()
|
|
86
|
+
```
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: ChaterJee
|
|
3
|
-
Version: 0.2.2
|
|
4
|
-
Summary: Communicate your project updates via Telegram Bot!
|
|
5
|
-
Author: Pallab Dutta
|
|
6
|
-
Author-email: pallab9997@gmail.com
|
|
7
|
-
Requires-Python: >=3.8
|
|
8
|
-
Description-Content-Type: text/markdown
|
|
9
|
-
Requires-Dist: python-telegram-bot==20.7
|
|
10
|
-
|
|
11
|
-
# ChaterJee
|
|
12
|
-
A Telegram ChatBot to Parse Research Project Updates
|
chaterjee-0.2.2/PKG-INFO
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: ChaterJee
|
|
3
|
-
Version: 0.2.2
|
|
4
|
-
Summary: Communicate your project updates via Telegram Bot!
|
|
5
|
-
Author: Pallab Dutta
|
|
6
|
-
Author-email: pallab9997@gmail.com
|
|
7
|
-
Requires-Python: >=3.8
|
|
8
|
-
Description-Content-Type: text/markdown
|
|
9
|
-
Requires-Dist: python-telegram-bot==20.7
|
|
10
|
-
|
|
11
|
-
# ChaterJee
|
|
12
|
-
A Telegram ChatBot to Parse Research Project Updates
|
chaterjee-0.2.2/README.md
DELETED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|