github-monitor 1.9rc1__py3-none-any.whl → 2.3__py3-none-any.whl

{github_monitor-1.9rc1.dist-info → github_monitor-2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github_monitor
-Version: 1.9rc1
+Version: 2.3
 Summary: Tool implementing real-time tracking of Github users activities including profile and repositories changes
 Author-email: Michal Szymanski <misiektoja-pypi@rm-rf.ninja>
 License-Expression: GPL-3.0-or-later
@@ -26,7 +26,7 @@ Dynamic: license-file
 
 # github_monitor
 
-github_monitor is a tool for real-time monitoring of GitHub users' activities, including profile and repository changes.
+OSINT tool for real-time monitoring of GitHub users' activities, including profile and repository changes.
 
 <a id="features"></a>
 ## Features
@@ -38,12 +38,16 @@ github_monitor is a tool for real-time monitoring of GitHub users' activities, i
    - added/removed starred repositories
    - added/removed public repositories
    - changes in user name, email, location, company, bio and blog URL
-   - detection of account changes
+   - changes in profile visibility (public to private and vice versa)
+   - changes in user's daily contributions
+   - detection when a user blocks or unblocks you
+   - detection of account metadata changes (such as account update date)
 - Email notifications for different events (new GitHub events, changed followings, followers, repositories, user name, email, location, company, bio, blog URL etc.)
 - Saving all user activities with timestamps to the CSV file
 - Clickable GitHub URLs printed in the console & included in email notifications (repos, PRs, commits, issues, releases etc.)
 - Possibility to control the running copy of the script via signals
 - Support for Public Web GitHub and GitHub Enterprise
+- Functional, procedural Python (minimal OOP)
 
 <p align="center">
    <img src="https://raw.githubusercontent.com/misiektoja/github_monitor/refs/heads/main/assets/github_monitor.png" alt="github_monitor_screenshot" width="100%"/>
@@ -56,12 +60,14 @@ github_monitor is a tool for real-time monitoring of GitHub users' activities, i
 2. [Installation](#installation)
    * [Install from PyPI](#install-from-pypi)
    * [Manual Installation](#manual-installation)
+   * [Upgrading](#upgrading)
 3. [Quick Start](#quick-start)
 4. [Configuration](#configuration)
    * [Configuration File](#configuration-file)
    * [GitHub Personal Access Token](#github-personal-access-token)
    * [GitHub API URL](#github-api-url)
    * [Events to Monitor](#events-to-monitor)
+   * [Repositories to Monitor](#repositories-to-monitor)
    * [Time Zone](#time-zone)
    * [SMTP Settings](#smtp-settings)
    * [Storing Secrets](#storing-secrets)
@@ -84,8 +90,8 @@ github_monitor is a tool for real-time monitoring of GitHub users' activities, i
 
 Tested on:
 
-* **macOS**: Ventura, Sonoma, Sequoia
-* **Linux**: Raspberry Pi OS (Bullseye, Bookworm), Ubuntu 24, Rocky Linux 8.x/9.x, Kali Linux 2024/2025
+* **macOS**: Ventura, Sonoma, Sequoia, Tahoe
+* **Linux**: Raspberry Pi OS (Bullseye, Bookworm, Trixie), Ubuntu 24/25, Rocky Linux 8.x/9.x, Kali Linux 2024/2025
 * **Windows**: 10, 11
 
 It should work on other versions of macOS, Linux, Unix and Windows as well.
@@ -117,6 +123,17 @@ Alternatively, from the downloaded *[requirements.txt](https://raw.githubusercon
 pip install -r requirements.txt
 ```
 
+<a id="upgrading"></a>
+### Upgrading
+
+To upgrade to the latest version when installed from PyPI:
+
+```sh
+pip install github_monitor -U
+```
+
+If you installed manually, download the newest *[github_monitor.py](https://raw.githubusercontent.com/misiektoja/github_monitor/refs/heads/main/github_monitor.py)* file to replace your existing installation.
+
 <a id="quick-start"></a>
 ## Quick Start
 
@@ -167,18 +184,16 @@ Provide the `GITHUB_TOKEN` secret using one of the following methods:
  - Pass it at runtime with `-t` / `--github-token`
  - Set it as an [environment variable](#storing-secrets) (e.g. `export GITHUB_TOKEN=...`)
  - Add it to [.env file](#storing-secrets) (`GITHUB_TOKEN=...`) for persistent use
+ - Fallback: hard-code it in the code or config file
 
-Fallback:
- - Hard-code it in the code or config file
-
-If you store the `GITHUB_TOKEN` in a dotenv file you can update its value and send a `SIGHUP` signal to the process to reload the file with the new token without restarting the tool. More info in [Storing Secrets](#storing-secrets) and [Signal Controls (macOS/Linux/Unix)](#signal-controls-macoslinuxunix).
+If you store the `GITHUB_TOKEN` in a dotenv file you can update its value and send a `SIGHUP` signal to reload the file with the new token without restarting the tool. More info in [Storing Secrets](#storing-secrets) and [Signal Controls (macOS/Linux/Unix)](#signal-controls-macoslinuxunix).
 
 <a id="github-api-url"></a>
 ### GitHub API URL
 
 By default the tool uses Public Web GitHub API URL: [https://api.github.com](https://api.github.com)
 
-If you want to use GitHub Enterprise API URL then change `GITHUB_API_URL` (or use `-x` flag) to: https://{your_hostname}/api/v3
+If you want to use GitHub Enterprise API URL then change `GITHUB_API_URL` (or use `-x` flag) to: `https://{your_hostname}/api/v3`
 
 
 <a id="events-to-monitor"></a>
@@ -192,6 +207,21 @@ By default all events are monitored, but if you want to limit it, then remove th
 EVENTS_TO_MONITOR=['PushEvent','PullRequestEvent', 'IssuesEvent', 'ForkEvent', 'ReleaseEvent']
 ```
 
+<a id="repositories-to-monitor"></a>
+### Repositories to Monitor
+
+When tracking repository changes (`-j` flag), you can limit which repositories will be monitored for detailed changes (stargazers, watchers, forks, issues, PRs, etc.). You can do it by changing the `REPOS_TO_MONITOR` configuration option or via the `--repos` command-line argument (see [Monitoring Mode](#monitoring-mode)).
+
+By default all repositories are monitored (`REPOS_TO_MONITOR = ['ALL']`), but if you want to monitor only specific repositories, you can use the `'user/repo_name'` format:
+
+```
+REPOS_TO_MONITOR = ['user1/repo1', 'user2/repo2', 'user1/repo3']
+```
+
+This allows you to have different repository lists for different users. When the tool runs for a specific user, it will only monitor repositories where the user matches the user in the list.
+
+Note: When using a specific list (not `'ALL'`), newly created repositories will NOT be automatically monitored - only repositories explicitly listed will be monitored.
+
 <a id="time-zone"></a>
 ### Time Zone
 
@@ -292,6 +322,28 @@ If you want to monitor changes to user's public repositories (e.g. new stargazer
 github_monitor github_username -j
 ```
 
+By default, only user-owned repos are tracked. To include forks and collaborations, set `GET_ALL_REPOS` to `True` or use the `-a` flag:
+
+```sh
+github_monitor github_username -j -a
+```
+
+If you want to monitor only specific repositories instead of all user-owned repositories, you can do it via the `--repos` command-line flag or the `REPOS_TO_MONITOR` configuration option (see [Repositories to Monitor](#repositories-to-monitor)). Use the `--repos` flag with a comma-separated list of repository names:
+
+```sh
+github_monitor github_username -j --repos "repo1,repo2,repo3"
+```
+
+This will only monitor detailed changes (stargazers, watchers, forks, issues, PRs, etc.) for the specified repositories. The `--repos` flag requires the `-j` flag to be enabled and overrides the `REPOS_TO_MONITOR` configuration option.
+
+Note: When using a specific list, newly created repositories will NOT be automatically monitored - only repositories explicitly listed will be monitored.
+
+If you want to track user's daily contributions then use the `-m` flag:
+
+```sh
+github_monitor github_username -m
+```
+
 If for any reason you do not want to monitor GitHub events for the user (e.g. new pushes, PRs, issues, forks, releases etc.), then use the `-k` flag:
 
 ```sh
@@ -319,6 +371,12 @@ github_monitor github_username -r
    <img src="https://raw.githubusercontent.com/misiektoja/github_monitor/refs/heads/main/assets/github_list_of_repos.png" alt="github_list_of_repos" width="90%"/>
 </p>
 
+By default, only user-owned repos are listed. To include forks and collaborations, set `GET_ALL_REPOS` to `True` or use the `-a` flag:
+
+```sh
+github_monitor github_username -r -a
+```
+
 If you want to display a list of repositories starred by the user then use the `-g` flag:
 
 ```sh
@@ -367,7 +425,7 @@ To get email notifications when changes in user repositories are detected (e.g.
 - or use the `-q` flag
 
 ```sh
-github_monitor github_username -q
+github_monitor github_username -j -q
 ```
 
 To be informed whenever changes in the update date of user repositories are detected:
@@ -375,11 +433,21 @@ To be informed whenever changes in the update date of user repositories are dete
 - or use the `-u` flag
 
 ```sh
-github_monitor github_username -u
+github_monitor github_username -j -u
 ```
 
 The last two options (`-q` and `-u`) only work if tracking of repositories changes is enabled (`-j`).
 
+To be informed about user's daily contributions:
+- set `CONTRIB_NOTIFICATION` to `True`
+- or use the `-y` flag
+
+```sh
+github_monitor github_username -m -y
+```
+
+The `-y` only works if tracking of daily contributions is enabled (`-m`).
+
 To disable sending an email on errors (enabled by default):
 - set `ERROR_NOTIFICATION` to `False`
 - or use the `-e` flag
@@ -433,6 +501,7 @@ List of supported signals:
 | USR2 | Toggle email notifications for new GitHub events (-s) |
 | CONT | Toggle email notifications for user's repositories changes (except for update date) (-q) |
 | PIPE | Toggle email notifications for user's repositories update date changes (-u) |
+| URG | Toggle email notifications for user's daily contributions changes (-y) |
 | TRAP | Increase the user check interval (by 1 min) |
 | ABRT | Decrease the user check interval (by 1 min) |
 | HUP | Reload secrets from .env file |

github_monitor-2.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+github_monitor.py,sha256=LLWOIE6qeSdO9tQWrPa9JfBhB3ahBJCjZ9G4lsleaLU,142687
+github_monitor-2.3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+github_monitor-2.3.dist-info/METADATA,sha256=kJvLcek22vNZmgxBtRq-9mRYsnHdqU-_MWZaG3u_rGs,19803
+github_monitor-2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+github_monitor-2.3.dist-info/entry_points.txt,sha256=hV03y00u1L16S5BwBSLQvFsZcL2WGRtjzlrmu9U9SN0,55
+github_monitor-2.3.dist-info/top_level.txt,sha256=HDN2988ydvH9JZT32PushzqrcD05Q5qg960vgHGIaI8,15
+github_monitor-2.3.dist-info/RECORD,,

{github_monitor-1.9rc1.dist-info → github_monitor-2.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any