drunken-chunk 1.0.0 → 1.0.1
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.
- package/README.md +40 -8
- package/drunken_chunk/__init__.py +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# 💧 Drunken Chunk (drunken-chunk)
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/drunken-chunk)
|
|
4
|
+
[](https://www.npmjs.com/package/drunken-chunk)
|
|
3
5
|
[](https://www.python.org/)
|
|
4
6
|
[](https://opensource.org/licenses/MIT)
|
|
5
7
|
[](#-supported-platforms--native-mechanics)
|
|
@@ -53,27 +55,57 @@ Drunken Chunk is built to operate with lightweight, native OS components instead
|
|
|
53
55
|
| 🍎 **macOS** | AppleScript `display notification` | `start_new_session` (`setsid`) background process | User Launch Agent (`~/Library/LaunchAgents/*.plist`) |
|
|
54
56
|
| 🐧 **Linux** | Desktop D-Bus `notify-send` utility | `start_new_session` (`setsid`) background process | XDG Desktop Entry (`~/.config/autostart/*.desktop`) |
|
|
55
57
|
|
|
56
|
-
---
|
|
57
|
-
|
|
58
58
|
## 🚀 Installation & Quick Start
|
|
59
59
|
|
|
60
|
-
### Prerequisites
|
|
61
|
-
* Python
|
|
60
|
+
### 📋 Prerequisites
|
|
61
|
+
* **Python 3.8+** installed (required for both installation methods; Drunken Chunk runs on pure Python).
|
|
62
|
+
* **Node.js 14.0+** installed (only if installing via **npm**).
|
|
62
63
|
* Standard command-line terminal environment.
|
|
63
64
|
|
|
64
|
-
|
|
65
|
-
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### 📦 Option A: Install via npm (Recommended for Node devs)
|
|
68
|
+
You can install Drunken Chunk globally using npm:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npm install -g drunken-chunk
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Test your installation by running the global command:
|
|
75
|
+
```bash
|
|
76
|
+
drunken-chunk --help
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
You can also run it instantly without global installation using `npx`:
|
|
80
|
+
```bash
|
|
81
|
+
npx drunken-chunk --help
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
> [!NOTE]
|
|
85
|
+
> Since this is a Node.js wrapper for a Python tool, you must have Python 3.8+ installed on your system.
|
|
86
|
+
|
|
87
|
+
---
|
|
66
88
|
|
|
89
|
+
### 🐍 Option B: Install via pip (Recommended for Python devs)
|
|
90
|
+
Install the package directly from PyPI:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
pip install drunken-chunk
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Or install it globally/in editable mode from source:
|
|
67
97
|
```bash
|
|
68
98
|
pip install -e .
|
|
69
99
|
```
|
|
70
100
|
|
|
71
|
-
|
|
101
|
+
Verify your installation:
|
|
72
102
|
```bash
|
|
73
103
|
drunken-chunk --help
|
|
74
104
|
```
|
|
75
105
|
|
|
76
|
-
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
### 🛠️ Option C: Run from Source (No installation)
|
|
77
109
|
If you prefer not to install the package globally, you can invoke the CLI using the platform-specific execution wrappers located at the repository root:
|
|
78
110
|
|
|
79
111
|
* **Windows PowerShell/Command Prompt:**
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
# Drunken Chunk - Water reminder and behavior analytics tool
|
|
2
|
-
__version__ = "1.0.
|
|
2
|
+
__version__ = "1.0.1"
|
package/package.json
CHANGED