Metadata-Version: 2.4
Name: pyrunning
Version: 0.0.17
Summary: A python library to run and live-log OS commands, functions, scripts, and batch jobs either immedietly, or to be queued for later execution.
Home-page: https://github.com/pvshvp-oss/pyrunning
Download-URL: https://pypi.org/project/pyrunning/
Author: pvshvp
Author-email: pvshvp.oss@gmail.com
Project-URL: Documentation, https://github.com/pvshvp-oss/pyrunning/
Project-URL: Source, https://github.com/pvshvp-oss/pyrunning
Project-URL: Tracker, https://github.com/pvshvp-oss/pyrunning/issues
Classifier: Programming Language :: Python :: 3.13
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Natural Language :: English
Classifier: Typing :: Typed
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary


# pyrunning

![GitHub](https://img.shields.io/github/license/pvshvp-oss/pyrunning)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/pvshvp-oss/pyrunning)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrunning?link=https%3A%2F%2Fpypi.org%2Fproject%2Fpyrunning%2F)](https://pypi.org/project/pyrunning/)
[![Release](https://github.com/pvshvp-oss/pyrunning/actions/workflows/release.yml/badge.svg)](https://github.com/pvshvp-oss/pyrunning/actions/workflows/release.yml)
[![Pre-Release (Git)](https://github.com/pvshvp-oss/pyrunning/actions/workflows/pre_release.yml/badge.svg)](https://github.com/pvshvp-oss/pyrunning/actions/workflows/pre_release.yml)

## Overview

A python library to run and live-log *OS commands*, *functions*, *scripts*, and *batch jobs* either immedietly, or to be queued for later execution.

**Warning**: This package is still in the Beta stage. It is not ready for production use. Please do not use for any critical software

<!-- ## [PLEASE CLICK HERE](https://github.com/pvshvp-oss/pyrunning/index.html) for the full documentation -->

## Cloning

In order to download the source code to your local computer for testing, or for development, you can clone from the remote repository using either SSH, or HTTPS. Below are instructions on how to do so using GitHub hosted code as remote.

### HTTPS

```bash
git clone https://github.com/pvshvp-oss/pyrunning.git 
```

OR

### SSH

```bash
git clone git@github.com:pvshvp-oss/pyrunning.git
```

## Packaging

### Arch Linux

Change to the project directory (`cd pyrunning`) and run any of the below scripts:
- `sh packaging/arch/setup.sh <MODE>`: Builds and installs a package
- `sh packaging/arch/build-package.sh <MODE>`: Just builds a package without installing it locally
- `sh packaging/arch/install-package.sh <MODE>`: Just installs a package locally, except if no built package is detected, a package is built.
 
### Debian

Change to the project directory (`cd pyrunning`) and run any of the below scripts:
- `sh packaging/debian/build-package.sh <MODE>`: Just builds a package without installing it locally

where `<MODE>` can be one of the below
     1. `local`: Selects *pyrunning-local* from the local project that you have cloned already.
     2. `git`: Selects *pyrunning-git* from the latest git commit. **Note** - Not available for Debian.
     3. `stable`: Selects *pyrunning* from the git tag corresponding to the [`pkgver` specified in the PKGBUILD](https://github.com/pvshvp-oss/pyrunning/blob/main/packaging/pyrunning/PKGBUILD#L17). If `pkgver=0.1.2`, then the git tag `v0.1.2` is used for packaging. 
     
> **Note**: Any additional parameters passed to the above scripts are automatically sent to `makepkg` or `pacman` (whichever is applicable).
