https://github.com/kuvaus/coffeepy
Coffeepy ☕️ is a small program that prevents the system from sleeping
https://github.com/kuvaus/coffeepy
awake caffeinate caffeine cli linux macos python sleep windows
Last synced: 3 months ago
JSON representation
Coffeepy ☕️ is a small program that prevents the system from sleeping
- Host: GitHub
- URL: https://github.com/kuvaus/coffeepy
- Owner: kuvaus
- License: mit
- Created: 2023-07-11T19:09:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-24T00:32:22.000Z (almost 3 years ago)
- Last Synced: 2025-09-18T18:47:56.921Z (9 months ago)
- Topics: awake, caffeinate, caffeine, cli, linux, macos, python, sleep, windows
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.python.org/pypi/coffeepy/) [](https://pypi.python.org/pypi/coffeepy)
# Coffeepy
Coffeepy ☕️ is a small program that prevents the system from sleeping.
Works on MacOS, Windows and Linux.
## Installation
```sh
pip install -U coffeepy
```
## Usage
Simply run the program from command line
```sh
coffeepy
```
By default the program runs indefinitely. Press `Ctrl-C` to quit
Optional: You can set the time in minutes with `-t` or `--time` flag. For example, to run the program for 1 hour, use
```sh
coffeepy -t 60
```
You can also disable animation with `-a` or `--no-animation` flag.
```sh
coffeepy -a
```
You can view the full parameter list with `-h` or `--help`.
## Python module
You can also import coffeepy as a python module
```python
import coffeepy
coffeepy.run()
```
Optional settings when run as a python module:
```python
import coffeepy
# you can also specify the time in minutes
# if no time is provided or time = 0, the program will run indefinitely
coffeepy.run(60)
# to disable animation when run as a module, you can set the second argument to True
coffeepy.run(0, True)
```
## License
This project is licensed under the MIT [License](https://github.com/kuvaus/coffeepy/blob/main/LICENSE)