-
-
Notifications
You must be signed in to change notification settings - Fork 7
fix: env fallback, py version bump #117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
74706f9
6d22628
2de6cc9
506874d
520cedd
6d12d66
dbf2f8c
adb00cd
d1fd537
6d3252b
a98fb20
b6f96b0
e6d496d
cbab4e7
e4da2a6
1d4f3db
488c260
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| #rename this file to .env | ||
|
|
||
| SIMKL_CLIENT_ID="id" | ||
| SIMKL_CLIENT_SECRET="secret" | ||
| SIMKL_CLIENT_SECRET="placeholder" | ||
| SIMKL_ACCESS_TOKEN="token" #optional | ||
|
|
||
| # Note: SIMKL_CLIENT_ID and SIMKL_CLIENT_SECRET should now be set as environment variables |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,32 +13,66 @@ Before installing, ensure you have the necessary system dependencies based on yo | |
| **For Ubuntu/Debian:** | ||
| ```bash | ||
| sudo apt install pipx python3-tk python3-pip python3-dev python3-setuptools wmctrl xdotool python3-gi python3-gi-cairo gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev pkg-config libnotify-bin python3-venv gir1.2-appindicator3-0.1 gnome-shell-extension-appindicator | ||
| ``` | ||
|
|
||
| **For Fedora/RHEL/CentOS:** | ||
| ```bash | ||
| sudo dnf install pipx python3-tk python3-pip python3-devel gobject-introspection-devel cairo-devel pkg-config python3-gobject gtk3 wmctrl xdotool libnotify | ||
| ``` | ||
|
|
||
| **For Arch Linux:** | ||
| ```bash | ||
| sudo pacman -S pipx python3-tk python-pip python-setuptools python-gobject gtk3 gobject-introspection cairo pkg-config wmctrl xdotool libnotify | ||
| ``` | ||
|
|
||
| ### Installation Process | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A[Install Dependencies] --> B[Install via pipx] | ||
| B --> C[Initialize Application] | ||
| C --> D[Authenticate with Simkl] | ||
| D --> E[Configure Media Players] | ||
| E --> F[Setup Autostart] | ||
| style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff | ||
| style D fill:#34a853,stroke:#333,stroke-width:2px,color:#fff | ||
| style F fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff | ||
| A[System Tray Icon] -->|Right-click| B[Context Menu] | ||
| B --> C[Status Information] | ||
| B --> D[Start/Pause Tracking] | ||
| B --> E[Scrobbling] | ||
| E --> E1[Retry Last Scrobble] | ||
| E --> E2[Sync Backlog Now] | ||
| E --> E3[Completion Threshold] | ||
| E --> E4[Open Local Watch History] | ||
| B --> E5[SIMKL] | ||
| E5 --> E5A[Authenticate/Re-auth] | ||
| E5 --> E5B[Open Website] | ||
| E5 --> E5C[Open Watch History] | ||
| B --> F[Maintenance] | ||
| F --> F1[Open Logs] | ||
| F --> F2[Open Data Folder] | ||
| F --> F3[Clear Backlog] | ||
| F --> F4[Clear Cache] | ||
| F --> F5[Clear Watch History] | ||
| F --> F6[Clear Logs] | ||
| F --> F7[Reset App Data] | ||
| B --> G[More] | ||
| G --> G1[Donate ❤️] | ||
| G --> G2[Check for Updates] | ||
| G --> G3[Help] | ||
| G --> G4[About] | ||
| B --> H[Exit] | ||
| style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff | ||
| style D fill:#34a853,stroke:#333,stroke-width:2px,color:#fff | ||
| style F fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff | ||
| ``` | ||
|
Comment on lines
17
to
40
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The installation instructions for Fedora/RHEL/CentOS and Arch Linux, along with the "Installation Process" diagram, have been removed. This appears to be unintentional, as it removes valuable information for users on those distributions. Please consider restoring the removed content. The new context menu diagram is a great addition and could be placed in a more relevant section, such as under "System Tray Integration". |
||
|
|
||
| - **Status information**: Current monitoring state and connection status | ||
| - **Start/Pause Tracking**: Pause or resume tracking on demand | ||
| - **Scrobbling**: Recovery and threshold controls | ||
| - **Retry Last Scrobble**: Clears cache for the active file and attempts to re-identify and scrobble it. Use when the wrong title/episode appears. | ||
| - **Sync Backlog Now**: Immediately processes any offline scrobbles waiting in backlog. | ||
| - **Completion Threshold**: Quickly switch between preset watch thresholds (65%, 80%, 90%) or define a custom percentage. | ||
| - **Open Local Watch History**: Open the local watch history viewer in your web browser. | ||
| - **SIMKL**: Account and service management | ||
| - **Authenticate / Re-authenticate**: Launch the Simkl login flow if you are signing in for the first time or need to refresh an expired token. | ||
| - **Open Website**: Visit the SIMKL website. | ||
| - **Open Watch History**: View your watch history on SIMKL. | ||
| - **Maintenance**: Logs, data, and cache management | ||
| - **Open Logs**: Jump straight to app diagnostics from the tray. | ||
| - **Open Data Folder**: Open the application data directory. | ||
| - **Clear Backlog**: Deletes pending offline scrobbles to stop repeated sync prompts. | ||
| - **Clear Cache**: Removes local media cache data while keeping logs and settings intact. | ||
| - **Clear Watch History**: Removes the local `watch_history.json` file and viewer data without touching your SIMKL account. | ||
| - **Clear Logs**: Truncates application and playback logs so you can capture a fresh session before debugging. | ||
| - **Reset App Data (Danger)**: Performs a full reset—use only when you want a clean re-authentication; the app exits afterward. | ||
| - **More**: Additional utilities | ||
| - **Donate ❤️**: Support the project. | ||
| - **Check for Updates**: Check if a newer version is available. | ||
| - **Help**: Open help documentation. | ||
| - **About**: View application information. | ||
| - **Exit**: Close the application | ||
|
|
||
| 1. Install the application using pipx (recommended for better isolation): | ||
| ```bash | ||
| # Install pipx if not already installed | ||
|
|
@@ -215,27 +249,61 @@ Right-click the system tray icon to access: | |
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| A[System Tray Icon] -->|Right-click| B[Context Menu] | ||
| B --> C[Status Information] | ||
| B --> D[Start/Pause Tracking] | ||
| B --> E[Tools Submenu] | ||
| B --> F[Online Services] | ||
| E --> E1[Open Logs] | ||
| E --> E2[Config Directory] | ||
| E --> E3[Process Backlog] | ||
| F --> F1[Simkl Website] | ||
| F --> F2[Watch History] | ||
| B --> G[Check for Updates] | ||
| B --> H[Help/About] | ||
| B --> I[Exit] | ||
| style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff | ||
| style D fill:#34a853,stroke:#333,stroke-width:2px,color:#fff | ||
| style F fill:#fbbc05,stroke:#333,stroke-width:2px | ||
| A[System Tray Icon] -->|Right-click| B[Context Menu] | ||
| B --> C[Status Information] | ||
| B --> D[Start/Pause Tracking] | ||
| B --> E[Scrobbling] | ||
| E --> E1[Retry Last Scrobble] | ||
| E --> E2[Sync Backlog Now] | ||
| E --> E3[Completion Threshold] | ||
| E --> E4[Open Local Watch History] | ||
| B --> E5[SIMKL] | ||
| E5 --> E5A[Authenticate/Re-auth] | ||
| E5 --> E5B[Open Website] | ||
| E5 --> E5C[Open Watch History] | ||
| B --> F[Maintenance] | ||
| F --> F1[Open Logs] | ||
| F --> F2[Open Data Folder] | ||
| F --> F3[Clear Backlog] | ||
| F --> F4[Clear Cache] | ||
| F --> F5[Clear Watch History] | ||
| F --> F6[Clear Logs] | ||
| F --> F7[Reset App Data] | ||
| B --> G[More] | ||
| G --> G1[Donate ❤️] | ||
| G --> G2[Check for Updates] | ||
| G --> G3[Help] | ||
| G --> G4[About] | ||
| B --> H[Exit] | ||
| style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff | ||
| style D fill:#34a853,stroke:#333,stroke-width:2px,color:#fff | ||
| style F fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff | ||
| ``` | ||
|
|
||
| - **Status information**: Current monitoring state and connection status | ||
| - **Start/Pause Tracking**: Toggle monitoring | ||
| - **Tools**: Access to logs, configuration, and backlog management | ||
| - **Start/Pause Tracking**: Pause or resume tracking on demand | ||
| - **Scrobbling**: Recovery and threshold controls | ||
| - **Retry Last Scrobble**: Clears cache for the active file and attempts to re-identify and scrobble it. Use when the wrong title/episode appears. | ||
| - **Sync Backlog Now**: Immediately processes any offline scrobbles waiting in backlog. | ||
| - **Completion Threshold**: Quickly switch between preset watch thresholds (65%, 80%, 90%) or define a custom percentage. | ||
| - **Open Local Watch History**: Open the local watch history viewer in your web browser. | ||
| - **SIMKL**: Account and service management | ||
| - **Authenticate / Re-authenticate**: Launch the Simkl login flow if you are signing in for the first time or need to refresh an expired token. | ||
| - **Open Website**: Visit the SIMKL website. | ||
| - **Open Watch History**: View your watch history on SIMKL. | ||
| - **Maintenance**: Logs, data, and cache management | ||
| - **Open Logs**: Jump straight to app diagnostics from the tray. | ||
| - **Open Data Folder**: Open the application data directory. | ||
| - **Clear Backlog**: Delete pending offline scrobbles to stop repeated sync prompts. | ||
| - **Clear Cache**: Remove media cache data while keeping logs and settings intact. | ||
| - **Clear Watch History**: Remove the local `watch_history.json` file and viewer data without touching your SIMKL account. | ||
| - **Clear Logs**: Truncate application and playback logs to capture a fresh session for debugging. | ||
| - **Reset App Data (Danger)**: Perform a full reset—use only when you want a clean re-authentication; the app will exit afterward. | ||
| - **More**: Additional utilities | ||
| - **Donate ❤️**: Support the project. | ||
| - **Check for Updates**: Check if a newer version is available. | ||
| - **Help**: Open help documentation. | ||
| - **About**: View application information. | ||
| - **Exit**: Close the application | ||
|
|
||
| ### Linux-Specific File Locations | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.