Skip to content

Commit b91da2e

Browse files
committed
Add pip package
1 parent 8ba2778 commit b91da2e

File tree

6 files changed

+61
-5
lines changed

6 files changed

+61
-5
lines changed

MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include LICENSE
2+

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
1+
[![PyPI version](https://badge.fury.io/py/RemoveWindowsLockScreenAds.svg)](https://badge.fury.io/py/RemoveWindowsLockScreenAds)
2+
13
# Remove Windows lock screen/Spotlight Ads
2-
Remove Windows lock screen/Spotlight ads while keeping the rotating Spotlight image backgrounds. **The effect is immediate, there is no restart or logoff required.**
4+
Remove Windows lock screen ads/Spotlight ads while keeping the rotating Spotlight image backgrounds. **The effect is immediate, there is no restart or logoff required.**
35

6+
This script can be run by any user, **no Administrator privileges are required.**
47

58
This script parses the JSON configuration for Spotlight, located in `%LOCALAPPDATA%`, to remove the buzzfeed-esque ads that clutter the lock screen.
69
<p align="center">
7-
<img src="screenshots/ad.PNG" />
10+
<img src="https://github.com/clarkb7/RemoveWindowsLockScreenAds/blob/master/screenshots/ad.PNG?raw=true" />
811
</p>
912

1013
By default the image credits are kept. Pass `--remove-credits` if you would like them removed, too.
1114
<p align="center">
12-
<img src="screenshots/credits.PNG" />
15+
<img src="https://github.com/clarkb7/RemoveWindowsLockScreenAds/blob/master/screenshots/credits.PNG?raw=true" />
1316
</p>
1417

15-
## Usage
18+
## Installation
19+
```
20+
python -m pip install --user RemoveWindowsLockScreenAds
21+
pythonw -m RemoveWindowsLockScreenAds --install
22+
```
23+
24+
## Try it out without modifying anything
1625
```
17-
usage: removeads.py [-h] [-v] [--dry-run] [--remove-credits] (--once | --watch | --install | --uninstall) [path]
26+
python -m RemoveWindowsLockScreenAds --once --dry-run --verbose
27+
```
28+
29+
## Detailed Usage
30+
```
31+
usage: RemoveWindowsLockScreenAds.py [-h] [-v] [--dry-run] [--remove-credits] (--once | --watch | --install | --uninstall) [path]
1832
1933
positional arguments:
2034
path Path to file or directory to remove lock screen ads from.
@@ -31,3 +45,4 @@ actions:
3145
--install Start in --watch mode on login
3246
--uninstall Remove installed files and login task
3347
```
48+

RemoveWindowsLockScreenAds.py renamed to RemoveWindowsLockScreenAds/RemoveWindowsLockScreenAds.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,3 +267,4 @@ def main(argv):
267267

268268
if __name__ == "__main__":
269269
main(sys.argv)
270+
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
from .RemoveWindowsLockScreenAds import GetAdSettingsDirectory, AdRemover
2+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import sys
2+
from .RemoveWindowsLockScreenAds import main
3+
main(sys.argv)
4+

setup.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
from setuptools import setup
2+
3+
with open("README.md", "r") as f:
4+
long_desc = f.read()
5+
6+
setup(
7+
name='RemoveWindowsLockScreenAds',
8+
version='0.1',
9+
description='Remove Windows lock screen ads/Spotlight ads while keeping the rotating Spotlight image backgrounds.',
10+
long_description=long_desc,
11+
long_description_content_type="text/markdown",
12+
url='https://github.com/clarkb7/RemoveWindowsLockScreenAds',
13+
license='MIT',
14+
15+
author='Branden Clark',
16+
author_email='[email protected]',
17+
18+
classifiers=[
19+
'Development Status :: 4 - Beta',
20+
'Operating System :: Microsoft :: Windows :: Windows 10',
21+
'Intended Audience :: End Users/Desktop',
22+
'License :: OSI Approved :: MIT License',
23+
'Natural Language :: English',
24+
'Programming Language :: Python :: 3 :: Only',
25+
'Topic :: Utilities',
26+
],
27+
keywords='windows-spotlight remove-ads windows-lockscreen',
28+
29+
packages=['RemoveWindowsLockScreenAds'],
30+
install_requires=['pywin32'],
31+
)
32+

0 commit comments

Comments
 (0)