Skip to main content

A small utility to remind you to go to sleep.

Project description

Quack Sleep Doc

Not an actual doctor or a serious sleep helper! If you need that consult a real doctor!

A tool that reminds you to go to bed at a time you configured.

Setup

Then, you create a config file in ~/.config/quack-sleep/config.json.

{
    "language": "de",
    "reminder_time": "22:10",
    "countdown_initial": 20,
    "countdown_reduction": 5,
    "countdown_minimum": 1
}

Optionally, you can configure your own messages that remind you to go to sleep in ~/.config/quack-sleep/messages.txt. Where each line is a message. Here is an example file in german.

Morgen wirst du froh sein, dass du jetzt schlafen gehst.
Schlaf ist wie ein kostenloses Upgrade.
Dein Gehirn ruft an: Es möchte ins Bett.
Produktivität beginnt mit Erholung.
Selbst KI gönnt sich Ruhezyklen – du solltest das auch.

Finally, once you have everything configured, you should add the script to the autostart to make sure it always runs.

Linux: Assuming you have screen (apt install screen) you can add the following to the bottom of your ~/.profile file.

protected_screen() {
    local name="$1"
    shift

    if [ -z "$name" ]; then
        echo "Usage: protected_screen <session-name> <command> [args...]"
        return 1
    fi

    # Check if the screen session already exists
    if screen -ls | grep -q "[.]${name}[[:space:]]"; then
        return 0
    fi

    if [ $# -eq 0 ]; then
        echo "No command provided. You must provide a command."
        return 1
    else
        screen -dmS "$name" "$@"
    fi
}

protected_screen quack-sleep uvx quack-sleep-doctor

Windows: Here we will use the ps1 script provided in the repository to launch the app. First clone the repository, then run uv sync to install it. Lastly, add the start.ps1 to your autostart folder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quack_sleep_doctor-0.2.0.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quack_sleep_doctor-0.2.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file quack_sleep_doctor-0.2.0.tar.gz.

File metadata

  • Download URL: quack_sleep_doctor-0.2.0.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for quack_sleep_doctor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ad2e7e64f2f31999ad2016455f22d5e648c37aac07cb3f738787165f550b852e
MD5 b8ff76c2631b59387759e55daf6014e9
BLAKE2b-256 763af25e914107299e3c4af440058a59987ce7edf5bf0ccc795c11a336ff3076

See more details on using hashes here.

Provenance

The following attestation bundles were made for quack_sleep_doctor-0.2.0.tar.gz:

Publisher: python-publish.yml on penguinmenac3/quack-sleep-doctor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quack_sleep_doctor-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for quack_sleep_doctor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c19abbdba33a947bbc3dcf554a5d25278889a653946003d716a1585c4ed214c4
MD5 6768c13098873527de773ae61c45a339
BLAKE2b-256 67c3198bcdebf1587071856660a3793b65db954c6ab4372f46ce9ae46e373fa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for quack_sleep_doctor-0.2.0-py3-none-any.whl:

Publisher: python-publish.yml on penguinmenac3/quack-sleep-doctor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page