<!-- [](https://codecov.io/gh/lursight/runem) -->
[](https://github.com/lursight/runem/actions/workflows/main.yml)
[](https://lursight.github.io/runem/)
# Run'em: Accelerate Your Development Workflow
**Boost Efficiency and Save Time**
Runem is a flexible, multi-process tool designed to speed up your everyday tasks by running them in parallel. Whether you're testing, linting, or deploying, runem helps you work smarter and faster.
## Why Choose Run'em?
- **Streamlined Task Management**: Configure tasks with ease using declarative .runem.yml files.
- **Multiprocess Execution**: Run multiple tasks simultaneously, minimizing wall-clock time.
- **Optimized for Monorepos**: Supports multiple projects and task types, with easy filtering and configuration.
- **Detailed Reporting**: Get insights into task execution time and efficiency gains.
## Contents
- [Run'em: Accelerate Your Development Workflow](#runem-accelerate-your-development-workflow)
- [Why Choose Run'em?](#why-choose-runem)
- [Contents](#contents)
- [Features At A Glance:](#features-at-a-glance)
- [Using Run'em](#using-runem)
- [Installation](#installation)
- [Quick-start](#quick-start)
- [Basic quick-start](#basic-quick-start)
- [A more complete quick-start](#a-more-complete-quick-start)
- [Basic Use](#basic-use)
- [Advanced Use](#advanced-use)
- [Advanced configuration options](#advanced-configuration-options)
- [Custom reports](#custom-reports)
- [Help and job discovery](#help-and-job-discovery)
- [Troubleshooting](#troubleshooting)
- [Contributing to and supporting runem](#contributing-to-and-supporting-runem)
- [Development](#development)
- [Sponsor](#sponsor)
- [About runem](#about-runem)
# Features At A Glance:
- **Tagging**: Easily run specific job groups (e.g., lint, test, python).
- **Phases**: Organize tasks by phase (e.g., edit, test, deploy).
- **Configurable Options**: Customize how jobs are executed using simple options.
- **Declarative**: Jobs are define using simple YAML in [.runem.yml](https://lursight.github.io/runem/docs/configuration.html) .
# Using Run'em
## Installation
```bash
pip install runem
```
## Quick-start
## Basic quick-start
Create the following `.runem.yml` file at the root of your project:
```yml
- job:
command: echo "hello world!"
```
Then anywhere in your project run `runem` to see how and when that task is run, and how long it took:
```bash
runem
```
To see the actual log output you will need to use `--verbose` as `runem` hides anything that isn't important. Only failures and reports are considered important.
```bash
# Or, to see "hello world!", use --verbose
runem --verbose # add --verbose to see the actual output
```
To see how you can control your job use `--help`:
```bash
runem --help
```
### A more complete quick-start
See [quick-start docs](https://lursight.github.io/runem/docs/quick_start.html) for more quick-start tips.
## Basic Use
See [docs on basic use and use-cases](https://lursight.github.io/runem/docs/basic_use.html) for a comprehensive introduction.
## Advanced Use
### Advanced configuration options
See [configuration docs](https://lursight.github.io/runem/docs/configuration.html) for advanced configuration and use.
### Custom reports
See [reporting docs](https://lursight.github.io/runem/docs/reports.html) for more information on how reporting works.
# Help and job discovery
`--help` is designed to help your team discover what jobs and tasks they can automated. Read more at
[help and discovery docs](https://lursight.github.io/runem/docs/help_and_job_discovery.html).
# Troubleshooting
See [troubleshooting and known issues docs](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html).
---
# Contributing to and supporting runem
Awesome runem created by lursight
## Development
Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
## Sponsor
[❤️ Sponsor this project](https://github.com/sponsors/lursight/)
# About runem
The runem mission is to improve developer velocity at
[Lursight Ltd.](https://lursight.com), read more about the runem
[mission](https://lursight.github.io/runem/docs/mission.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "runem",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "example, runem",
"author": "lursight",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/16/c7/d4b5eaec5b256877a75501a41b5cf9b8ba6ad629caa6eee3def40689660d/runem-0.5.0.tar.gz",
"platform": null,
"description": "<!-- [](https://codecov.io/gh/lursight/runem) -->\n[](https://github.com/lursight/runem/actions/workflows/main.yml)\n[](https://lursight.github.io/runem/)\n\n# Run'em: Accelerate Your Development Workflow\n**Boost Efficiency and Save Time**\nRunem is a flexible, multi-process tool designed to speed up your everyday tasks by running them in parallel. Whether you're testing, linting, or deploying, runem helps you work smarter and faster.\n\n## Why Choose Run'em?\n- **Streamlined Task Management**: Configure tasks with ease using declarative .runem.yml files.\n- **Multiprocess Execution**: Run multiple tasks simultaneously, minimizing wall-clock time.\n- **Optimized for Monorepos**: Supports multiple projects and task types, with easy filtering and configuration.\n- **Detailed Reporting**: Get insights into task execution time and efficiency gains.\n\n## Contents\n- [Run'em: Accelerate Your Development Workflow](#runem-accelerate-your-development-workflow)\n - [Why Choose Run'em?](#why-choose-runem)\n - [Contents](#contents)\n- [Features At A Glance:](#features-at-a-glance)\n- [Using Run'em](#using-runem)\n - [Installation](#installation)\n - [Quick-start](#quick-start)\n - [Basic quick-start](#basic-quick-start)\n - [A more complete quick-start](#a-more-complete-quick-start)\n - [Basic Use](#basic-use)\n - [Advanced Use](#advanced-use)\n - [Advanced configuration options](#advanced-configuration-options)\n - [Custom reports](#custom-reports)\n- [Help and job discovery](#help-and-job-discovery)\n- [Troubleshooting](#troubleshooting)\n- [Contributing to and supporting runem](#contributing-to-and-supporting-runem)\n - [Development](#development)\n - [Sponsor](#sponsor)\n- [About runem](#about-runem)\n\n\n# Features At A Glance:\n- **Tagging**: Easily run specific job groups (e.g., lint, test, python).\n- **Phases**: Organize tasks by phase (e.g., edit, test, deploy).\n- **Configurable Options**: Customize how jobs are executed using simple options.\n- **Declarative**: Jobs are define using simple YAML in [.runem.yml](https://lursight.github.io/runem/docs/configuration.html) .\n\n# Using Run'em\n\n## Installation\n\n```bash\npip install runem\n```\n\n## Quick-start\n\n## Basic quick-start\nCreate the following `.runem.yml` file at the root of your project:\n\n```yml\n- job:\n command: echo \"hello world!\"\n```\n\nThen anywhere in your project run `runem` to see how and when that task is run, and how long it took:\n```bash\nrunem\n```\n\nTo see the actual log output you will need to use `--verbose` as `runem` hides anything that isn't important. Only failures and reports are considered important.\n```bash\n# Or, to see \"hello world!\", use --verbose\nrunem --verbose # add --verbose to see the actual output\n```\n\nTo see how you can control your job use `--help`:\n```bash\nrunem --help\n```\n\n### A more complete quick-start\n\nSee [quick-start docs](https://lursight.github.io/runem/docs/quick_start.html) for more quick-start tips.\n\n## Basic Use\n\nSee [docs on basic use and use-cases](https://lursight.github.io/runem/docs/basic_use.html) for a comprehensive introduction.\n\n## Advanced Use\n\n### Advanced configuration options\nSee [configuration docs](https://lursight.github.io/runem/docs/configuration.html) for advanced configuration and use.\n\n### Custom reports\nSee [reporting docs](https://lursight.github.io/runem/docs/reports.html) for more information on how reporting works.\n\n\n# Help and job discovery\n\n`--help` is designed to help your team discover what jobs and tasks they can automated. Read more at \n[help and discovery docs](https://lursight.github.io/runem/docs/help_and_job_discovery.html).\n\n# Troubleshooting\n\nSee [troubleshooting and known issues docs](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html).\n\n---\n# Contributing to and supporting runem\n\nAwesome runem created by lursight\n\n## Development\n\nRead the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n\n## Sponsor\n\n[\u2764\ufe0f Sponsor this project](https://github.com/sponsors/lursight/)\n\n# About runem\nThe runem mission is to improve developer velocity at\n[Lursight Ltd.](https://lursight.com), read more about the runem\n[mission](https://lursight.github.io/runem/docs/mission.html).\n\n",
"bugtrack_url": null,
"license": "Specify your license here",
"summary": "Awesome runem created by lursight",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/lursight/runem/"
},
"split_keywords": [
"example",
" runem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3ce02c16e07937a3090f0adf7956b99f099f23d057e8ef279d5af361f7a6d25",
"md5": "6f523b6e918145c4254a25686af023d6",
"sha256": "c09410f95467f11711ae351a7812511ac1173f165494ea9dda90097e9bfdaacf"
},
"downloads": -1,
"filename": "runem-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f523b6e918145c4254a25686af023d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 54795,
"upload_time": "2024-12-12T23:54:14",
"upload_time_iso_8601": "2024-12-12T23:54:14.362255Z",
"url": "https://files.pythonhosted.org/packages/e3/ce/02c16e07937a3090f0adf7956b99f099f23d057e8ef279d5af361f7a6d25/runem-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16c7d4b5eaec5b256877a75501a41b5cf9b8ba6ad629caa6eee3def40689660d",
"md5": "4323706f551fe71ef490cc971177b7ef",
"sha256": "57d6a50cbb9ab8f1b3a0703737dbc3e0db89f805ecdd3a4ffe65cf430d6239e1"
},
"downloads": -1,
"filename": "runem-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "4323706f551fe71ef490cc971177b7ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 86608,
"upload_time": "2024-12-12T23:54:15",
"upload_time_iso_8601": "2024-12-12T23:54:15.993553Z",
"url": "https://files.pythonhosted.org/packages/16/c7/d4b5eaec5b256877a75501a41b5cf9b8ba6ad629caa6eee3def40689660d/runem-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 23:54:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lursight",
"github_project": "runem",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "runem"
}
JSON
