Skip to content
This repository was archived by the owner on Feb 8, 2023. It is now read-only.

Commit 93e9f50

Browse files
committed
Prepare the last version of Nudge-Python
1 parent 16a656e commit 93e9f50

5 files changed

Lines changed: 16 additions & 223 deletions

File tree

README.md

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,25 @@
1-
# Nudge (macadmin's Slack #nudge)
1+
# Nudge-Python (macadmin's Slack #nudge)
2+
Nudge-Python is now considered End Of Life (EOL) as of February 11th, 2021. The last official version is 2.0.1 which enabled Big Sur support through the use of [macadmins/python 3.9.1](https://github.com/macadmins/python)
3+
4+
If you are using a fork of Nudge-Python [(a well known one is located here)](https://github.com/LcTrKiD/nudge), support will not be offered unless the developer of the fork decides to continue support.
5+
6+
[While Nudge-Python does support Big Sur, it is recommended to use the new version of Nudge, based on SwiftUI 5.2. You can find that project here.](https://github.com/macadmins/nudge)
7+
8+
On March 1st, 2021, this project will be marked as archived through GitHub.
29

310
## Nudge functionality overview
411
- Nudge, rather than trying to install updates, merely prompts users to install updates via an approved method (System Preferences, Munki, Jamf, etc.).
512
- By default, Nudge will open every 30 minutes, at the 0 and 30 minute mark. This is because of the default launch agent. If you find this behavior too aggressive, please change the launch agent.
613
- The timers are for if the user minimizes/hides the window. It will re-load the window into the foreground, taking precedence over any window.
7-
- If you want a certain number of days between notifications, you can set that using the `days_between_notifications` preference.
814
- Read Alan Siu's [Introduction to Nudge](https://www.alansiu.net/2019/12/24/nudge/) blog post for a more in-depth introduction to Nudge.
915

10-
## Embedded Python
11-
As of v2.0, Nudge now uses its own embedded python (currently v3.8). This is due to Apple's upcoming removal of Python2.
16+
## Macadmins Python
17+
As of v2.0.1, Nudge now requires [macadmins/python 3.9.1](https://github.com/macadmins/python). 3.9.1 is backwards compatible with 10.9.5 through Big Sur 11.0
1218

1319
Gurl has been updated from the Munki 4.0 release.
1420

1521
Nibbler has been updated to support python 3.
1622

17-
### Building embedded python framework
18-
19-
To reduce the size of the git repository, you **must** create your own Python. To do this, simply run the `./build_python_framework` script within the repository.
20-
21-
This process was tested on Catalina only.
22-
23-
```
24-
./build_python_framework
25-
26-
Cloning relocatable-python tool from github...
27-
Cloning into '/tmp/relocatable-python-git'...
28-
remote: Enumerating objects: 28, done.
29-
remote: Counting objects: 100% (28/28), done.
30-
remote: Compressing objects: 100% (19/19), done.
31-
remote: Total 78 (delta 12), reused 19 (delta 9), pack-reused 50
32-
Unpacking objects: 100% (78/78), done.
33-
Downloading https://www.python.org/ftp/python/3.8.0/python-3.8.0-macosx10.9.pkg...
34-
35-
...
36-
37-
Done!
38-
Customized, relocatable framework is at /Library/nudge/Python.framework
39-
Moving Python.framework to nudge munki-pkg payload folder
40-
Taking ownership of the file to not break git
41-
```
42-
4323
## Important Information
4424
You most certainly want to customize the following values:
4525

@@ -57,6 +37,8 @@ Also, you will at the very least want to change the `company_logo.png`
5737
## Building this package
5838
You will need to use [munki-pkg](https://github.com/munki/munki-pkg) to build this package.
5939

40+
** This is not to be confused with [munki](https://github.com/munki/munki).** Munki-Pkg is a standalone project that works with all macOS tooling and MDMs
41+
6042
## Credits
6143
This tool would not be possible without [nibbler](https://github.com/pudquick/nibbler), written by [Michael Lynn](https://twitter.com/mikeymikey).
6244

@@ -75,10 +57,11 @@ The following operating system and versions have been tested.
7557
- 10.14 -> 10.14.6
7658
- 10.15 -> 10.15.1
7759

78-
## OS Support v2 (embedded python)
60+
## OS Support v2 (macadmins python)
7961
The following operating system and versions have been tested with the embedded python.
8062
- 10.14
8163
- 10.15
64+
- 11
8265

8366
## Configuration File
8467
Essentially every component of the UI is customizable, all through a JSON configuration file. An [example file](/example_config.json) is available within the code repository.

build-info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
"ownership": "recommended",
77
"postinstall_action": "none",
88
"suppress_bundle_relocation": true,
9-
"version": "2.0"
9+
"version": "2.0.1"
1010
}

build_python_framework

Lines changed: 0 additions & 69 deletions
This file was deleted.

payload/Library/LaunchAgents/com.erikng.nudge.plist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
</array>
1111
<key>ProgramArguments</key>
1212
<array>
13+
<string>/Library/ManagedFrameworks/Python/Python3.framework/Versions/Current/bin/python3</string>
1314
<string>/Library/nudge/Resources/nudge</string>
1415
<string>--jsonurl=https://fake.domain.com/path/to/config.json</string>
1516
</array>

py3_requirements.txt

Lines changed: 0 additions & 122 deletions
This file was deleted.

0 commit comments

Comments
 (0)