Metadata-Version: 2.4
Name: pyshallow
Version: 2026.7.5
Summary: PyShallow - prevents screen saver / screen lock / turn off from kicking in
Author-email: Cristi Fati <fati_utcluj@yahoo.com>
Maintainer-email: Cristi Fati <fati_utcluj@yahoo.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/CristiFati/pyshallow
Project-URL: Download, https://pypi.org/project/pyshallow
Project-URL: Repository, https://github.com/CristiFati/pyshallow.git
Project-URL: Issues, https://github.com/CristiFati/pyshallow/issues
Keywords: development,productivity,tools,utilities
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pycfutils>=2025.5.6
Dynamic: license-file

# PyShallow

[![PyPI version](https://img.shields.io/pypi/v/pyshallow)](https://pypi.org/project/pyshallow)
[![Python versions](https://img.shields.io/pypi/pyversions/pyshallow)](https://pypi.org/project/pyshallow)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**PyShallow** prevents screen saver, screen lock, idle sleep from kicking in.

## Install

```shell
python -m pip install --upgrade pyshallow
```

## Standalone executables

Starting with **v2026.07.05**, pre-built executables (built with [PyInstaller](https://pyinstaller.org)) are available on the [Releases](https://github.com/CristiFati/pyshallow/releases) page.

- Linux: a `.desktop` launcher and (.png) icon are available in the [`assets/linux`](https://github.com/CristiFati/pyshallow/tree/main/assets/linux) directory
- macOS: an `.icns` icon is available in the [`assets/macos`](https://github.com/CristiFati/pyshallow/tree/main/assets/macos) directory
- Windows: an `.ico` icon is available in the [`assets/windows`](https://github.com/CristiFati/pyshallow/tree/main/assets/windows) directory

## Usage

Entry-point (must be in *PATH*):

```shell
pyshallow
```

As a module:

```shell
python -m pyshallow
```

Standalone executable:

```shell
./PyShallow-<version>-<platform>-<arch>-<pyver>
```

For available options:

```shell
pyshallow --help
```

## Notes

- Supports **Linux** (X11), **Windows** and **macOS**.
- Depends on [PyCFUtils](https://pypi.org/project/pycfutils)
- **Use it responsibly** (be aware of all implications)
- Parts of code assisted by [Claude Code](https://claude.ai/code)
- Icon/logo generated with [ChatGPT](https://chatgpt.com)

## Contributing

Contributions are welcome. Please open an issue or submit a pull request on [GitHub](https://github.com/CristiFati/pyshallow).

## License

This project is licensed under the [MIT License](LICENSE).
