https://github.com/bmwant/hapless

Run and manage background processes
https://github.com/bmwant/hapless

automation background-jobs cli devops jobs process-manager python python3 runner script tool ukraine

Last synced: 2 days ago
JSON representation

Run and manage background processes

• Host: GitHub
• URL: https://github.com/bmwant/hapless
• Owner: bmwant
• Created: 2022-04-14T12:02:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-10T18:22:33.000Z (17 days ago)
• Last Synced: 2024-12-18T10:02:05.852Z (9 days ago)
• Topics: automation, background-jobs, cli, devops, jobs, process-manager, python, python3, runner, script, tool, ukraine
• Language: Python
• Homepage: https://bmwant.link/hapless-easily-run-and-manage-background-processes/
• Size: 301 KB
• Stars: 128
• Watchers: 4
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
## hapless

![Checks](https://github.com/bmwant/hapless/actions/workflows/tests.yml/badge.svg)

[![PyPI](https://img.shields.io/pypi/v/hapless)](https://pypi.org/project/hapless/)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hapless)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![EditorConfig](https://img.shields.io/badge/-EditorConfig-grey?logo=editorconfig)](https://editorconfig.org/)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

> **hapless** (*adjective*) - (especially of a person) unfortunate. A developer who accidentally launched long-running process in the foreground.

Simplest way of running and tracking processes in the background.

[![asciicast](https://asciinema.org/a/489924.svg)](https://asciinema.org/a/489924?speed=2)

### Installation

```bash

$ pip install hapless

# or to make sure proper pip is used for the given python executable

$ python -m pip install hapless

```

Install into user-specific directory in case of any permissions-related issues.

```bash

$ pip install --user hapless

$ python -m pip install --user hapless

```

### Usage

```bash

# Run arbitrary script

$ hap run -- python long_running.py

# Show summary table

$ hap

# Display status of the specific process

$ hap status 1

```

See [USAGE.md](https://github.com/bmwant/hapless/blob/main/USAGE.md) for the complete list of commands and available parameters.

### Contribute

See [DEVELOP.md](https://github.com/bmwant/hapless/blob/main/DEVELOP.md) to setup your local development environment and feel free to create a pull request with a new feature.

### Releases changelog

Changelog file was removed; you can now view the changes made in each release on the [Releases](https://github.com/bmwant/hapless/releases) page.

### See also

* [Rich](https://rich.readthedocs.io/en/stable/introduction.html) console UI library.

* [Supervisor](http://supervisord.org/) full-fledged process manager.

* [podmena](https://github.com/bmwant/podmena) provides nice emoji icons to commit messages.

### Support 🇺🇦 Ukraine in the war!

🇺🇦 Donate to [this foundation](https://prytulafoundation.org/en) in case you want to help. Every donation matter!