runem 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- runem/VERSION +1 -1
- runem/blocking_print.py +10 -2
- runem/cli/initialise_options.py +26 -0
- runem/command_line.py +23 -1
- runem/config_parse.py +21 -7
- runem/job_execute.py +3 -2
- runem/log.py +23 -4
- runem/report.py +4 -1
- runem/run_command.py +62 -26
- runem/runem.py +46 -60
- runem/types/__init__.py +2 -1
- runem/utils.py +12 -0
- runem-0.6.0.dist-info/METADATA +161 -0
- runem-0.6.0.dist-info/RECORD +52 -0
- {runem-0.4.0.dist-info → runem-0.6.0.dist-info}/WHEEL +1 -1
- {runem-0.4.0.dist-info → runem-0.6.0.dist-info}/top_level.txt +1 -0
- scripts/test_hooks/__init__.py +0 -0
- scripts/test_hooks/json_validators.py +32 -0
- scripts/test_hooks/py.py +292 -0
- scripts/test_hooks/py.typed +0 -0
- scripts/test_hooks/runem_hooks.py +19 -0
- scripts/test_hooks/yarn.py +48 -0
- tests/cli/test_initialise_options.py +105 -0
- tests/data/help_output.3.10.txt +55 -0
- tests/data/help_output.3.11.txt +55 -0
- runem-0.4.0.dist-info/METADATA +0 -155
- runem-0.4.0.dist-info/RECORD +0 -42
- {runem-0.4.0.dist-info → runem-0.6.0.dist-info}/LICENSE +0 -0
- {runem-0.4.0.dist-info → runem-0.6.0.dist-info}/entry_points.txt +0 -0
runem-0.4.0.dist-info/METADATA
DELETED
@@ -1,155 +0,0 @@
|
|
1
|
-
Metadata-Version: 2.1
|
2
|
-
Name: runem
|
3
|
-
Version: 0.4.0
|
4
|
-
Summary: Awesome runem created by lursight
|
5
|
-
Home-page: https://github.com/lursight/runem/
|
6
|
-
Author: lursight
|
7
|
-
Description-Content-Type: text/markdown
|
8
|
-
License-File: LICENSE
|
9
|
-
Requires-Dist: packaging
|
10
|
-
Requires-Dist: PyYAML
|
11
|
-
Requires-Dist: rich
|
12
|
-
Requires-Dist: typing_extensions
|
13
|
-
Provides-Extra: tests
|
14
|
-
Requires-Dist: black==24.10.0; extra == "tests"
|
15
|
-
Requires-Dist: coverage==7.5; extra == "tests"
|
16
|
-
Requires-Dist: docformatter==1.7.5; extra == "tests"
|
17
|
-
Requires-Dist: flake8-bugbear==24.2.6; extra == "tests"
|
18
|
-
Requires-Dist: flake8==7.0.0; extra == "tests"
|
19
|
-
Requires-Dist: gitchangelog==3.0.4; extra == "tests"
|
20
|
-
Requires-Dist: isort==5.13.2; extra == "tests"
|
21
|
-
Requires-Dist: mkdocs==1.5.3; extra == "tests"
|
22
|
-
Requires-Dist: mypy==1.9.0; extra == "tests"
|
23
|
-
Requires-Dist: pydocstyle==6.3.0; extra == "tests"
|
24
|
-
Requires-Dist: pylint==3.1.0; extra == "tests"
|
25
|
-
Requires-Dist: pylama==8.4.1; extra == "tests"
|
26
|
-
Requires-Dist: pytest-cov==6.0.0; extra == "tests"
|
27
|
-
Requires-Dist: pytest-profiling==1.7.0; extra == "tests"
|
28
|
-
Requires-Dist: pytest-xdist==3.6.1; extra == "tests"
|
29
|
-
Requires-Dist: pytest==8.3.3; extra == "tests"
|
30
|
-
Requires-Dist: setuptools; extra == "tests"
|
31
|
-
Requires-Dist: termplotlib==0.3.9; extra == "tests"
|
32
|
-
Requires-Dist: tox; extra == "tests"
|
33
|
-
Requires-Dist: types-PyYAML==6.0.12.20240311; extra == "tests"
|
34
|
-
Requires-Dist: requests-mock==1.11.0; extra == "tests"
|
35
|
-
Requires-Dist: types-setuptools; extra == "tests"
|
36
|
-
|
37
|
-
<!-- [](https://codecov.io/gh/lursight/runem) -->
|
38
|
-
[](https://github.com/lursight/runem/actions/workflows/main.yml)
|
39
|
-
[](https://lursight.github.io/runem/)
|
40
|
-
|
41
|
-
# Run'em: Accelerate Your Development Workflow
|
42
|
-
**Boost Efficiency and Save Time**
|
43
|
-
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.
|
44
|
-
|
45
|
-
## Why Choose Run'em?
|
46
|
-
- **Streamlined Task Management**: Configure tasks with ease using declarative .runem.yml files.
|
47
|
-
- **Multiprocess Execution**: Run multiple tasks simultaneously, minimizing wall-clock time.
|
48
|
-
- **Optimized for Monorepos**: Supports multiple projects and task types, with easy filtering and configuration.
|
49
|
-
- **Detailed Reporting**: Get insights into task execution time and efficiency gains.
|
50
|
-
|
51
|
-
## Contents
|
52
|
-
- [Run'em: Accelerate Your Development Workflow](#runem-accelerate-your-development-workflow)
|
53
|
-
- [Why Choose Run'em?](#why-choose-runem)
|
54
|
-
- [Contents](#contents)
|
55
|
-
- [Features At A Glance:](#features-at-a-glance)
|
56
|
-
- [Using Run'em](#using-runem)
|
57
|
-
- [Installation](#installation)
|
58
|
-
- [Quick-start](#quick-start)
|
59
|
-
- [Basic quick-start](#basic-quick-start)
|
60
|
-
- [A more complete quick-start](#a-more-complete-quick-start)
|
61
|
-
- [Basic Use](#basic-use)
|
62
|
-
- [Advanced Use](#advanced-use)
|
63
|
-
- [Advanced configuration options](#advanced-configuration-options)
|
64
|
-
- [Custom reports](#custom-reports)
|
65
|
-
- [Help and job discovery](#help-and-job-discovery)
|
66
|
-
- [Troubleshooting](#troubleshooting)
|
67
|
-
- [Contributing to and supporting runem](#contributing-to-and-supporting-runem)
|
68
|
-
- [Development](#development)
|
69
|
-
- [Sponsor](#sponsor)
|
70
|
-
- [About runem](#about-runem)
|
71
|
-
|
72
|
-
|
73
|
-
# Features At A Glance:
|
74
|
-
- **Tagging**: Easily run specific job groups (e.g., lint, test, python).
|
75
|
-
- **Phases**: Organize tasks by phase (e.g., edit, test, deploy).
|
76
|
-
- **Configurable Options**: Customize how jobs are executed using simple options.
|
77
|
-
- **Declarative**: Jobs are define using simple YAML in [.runem.yml](https://lursight.github.io/runem/docs/configuration.html) .
|
78
|
-
|
79
|
-
# Using Run'em
|
80
|
-
|
81
|
-
## Installation
|
82
|
-
|
83
|
-
```bash
|
84
|
-
pip install runem
|
85
|
-
```
|
86
|
-
|
87
|
-
## Quick-start
|
88
|
-
|
89
|
-
## Basic quick-start
|
90
|
-
Create the following `.runem.yml` file at the root of your project:
|
91
|
-
|
92
|
-
```yml
|
93
|
-
- job:
|
94
|
-
command: echo "hello world!"
|
95
|
-
```
|
96
|
-
|
97
|
-
Then anywhere in your project run `runem` to see how and when that task is run, and how long it took:
|
98
|
-
```bash
|
99
|
-
runem
|
100
|
-
```
|
101
|
-
|
102
|
-
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.
|
103
|
-
```bash
|
104
|
-
# Or, to see "hello world!", use --verbose
|
105
|
-
runem --verbose # add --verbose to see the actual output
|
106
|
-
```
|
107
|
-
|
108
|
-
To see how you can control your job use `--help`:
|
109
|
-
```bash
|
110
|
-
runem --help
|
111
|
-
```
|
112
|
-
|
113
|
-
### A more complete quick-start
|
114
|
-
|
115
|
-
See [quick-start docs](https://lursight.github.io/runem/docs/quick_start.html) for more quick-start tips.
|
116
|
-
|
117
|
-
## Basic Use
|
118
|
-
|
119
|
-
See [docs on basic use and use-cases](https://lursight.github.io/runem/docs/basic_use.html) for a comprehensive introduction.
|
120
|
-
|
121
|
-
## Advanced Use
|
122
|
-
|
123
|
-
### Advanced configuration options
|
124
|
-
See [configuration docs](https://lursight.github.io/runem/docs/configuration.html) for advanced configuration and use.
|
125
|
-
|
126
|
-
### Custom reports
|
127
|
-
See [reporting docs](https://lursight.github.io/runem/docs/reports.html) for more information on how reporting works.
|
128
|
-
|
129
|
-
|
130
|
-
# Help and job discovery
|
131
|
-
|
132
|
-
`--help` is designed to help your team discover what jobs and tasks they can automated. Read more at
|
133
|
-
[help and discovery docs](https://lursight.github.io/runem/docs/help_and_job_discovery.html).
|
134
|
-
|
135
|
-
# Troubleshooting
|
136
|
-
|
137
|
-
See [troubleshooting and known issues docs](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html).
|
138
|
-
|
139
|
-
---
|
140
|
-
# Contributing to and supporting runem
|
141
|
-
|
142
|
-
Awesome runem created by lursight
|
143
|
-
|
144
|
-
## Development
|
145
|
-
|
146
|
-
Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
147
|
-
|
148
|
-
## Sponsor
|
149
|
-
|
150
|
-
[❤️ Sponsor this project](https://github.com/sponsors/lursight/)
|
151
|
-
|
152
|
-
# About runem
|
153
|
-
The runem mission is to improve developer velocity at
|
154
|
-
[Lursight Ltd.](https://lursight.com), read more about the runem
|
155
|
-
[mission](https://lursight.github.io/runem/docs/mission.html).
|
runem-0.4.0.dist-info/RECORD
DELETED
@@ -1,42 +0,0 @@
|
|
1
|
-
runem/VERSION,sha256=QLjrQACpE6d5EJBTXykdPTaYdBYqie88nj1OiHobnnk,6
|
2
|
-
runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
3
|
-
runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
|
4
|
-
runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
|
5
|
-
runem/blocking_print.py,sha256=R3c3HSnRMPCf7ykDXdKG2hKH4CzbBaxmOfP3xEU_wEI,1919
|
6
|
-
runem/cli.py,sha256=wEt_Jnumhl8SiOdKdSJzLkJpWv6n3_Odhi_HeIixr1k,134
|
7
|
-
runem/command_line.py,sha256=HsZjxJsVQZLfAeSRI6cpx6P1foeuqCYhHmeQ8Xg9RHY,13774
|
8
|
-
runem/config.py,sha256=UiEU0Jyg5qjrNStvasWYjMOABQHhpZjbPiX3-sH_CMg,5969
|
9
|
-
runem/config_metadata.py,sha256=krDomUcADsAeUQrxwNmOS58eeaNIlqmhWIKWv8mUH4A,3300
|
10
|
-
runem/config_parse.py,sha256=sXPMA8HSUcaJoq0dUfphK181waZqnIrq20mpYOQ_XCo,13498
|
11
|
-
runem/files.py,sha256=59boeFvUANYOS-PllIjeKIht6lNINZ43WxahDg90oAc,4392
|
12
|
-
runem/hook_manager.py,sha256=H0TL3HCqU2mgKm_-dgCD7TsK5T1bLT4g7x6kpytMPhU,4350
|
13
|
-
runem/informative_dict.py,sha256=U7p9z78UwOT4TAfng1iDXCEyeYz6C-XZlx9Z1pWNVrI,1548
|
14
|
-
runem/job.py,sha256=NOdRQnGePPyYdmIR_6JKVFzp9nbgNGetpE13bHEHaf4,3442
|
15
|
-
runem/job_execute.py,sha256=BPkeTpeTGJs3QWa0-07DZvF1f0uKO79e4yMsTxq1UHk,4656
|
16
|
-
runem/job_filter.py,sha256=7vgG4YWJ9gyGBFjV7QbSojG5ofYoszAmxXx9HnMLkHo,5384
|
17
|
-
runem/job_runner_simple_command.py,sha256=iP5an6yixW8o4C0ZBtu6csb-oVK3Q62ZZgtHBmxlXaU,2428
|
18
|
-
runem/job_wrapper.py,sha256=q5GtopZ5vhSJ581rwU4-lF9KnbL3ZYgOC8fqaCnXD_g,983
|
19
|
-
runem/job_wrapper_python.py,sha256=rx7J_N-JXs8GgMq7Sla7B9s_ZAfofKUhEnzgMcq_bts,4303
|
20
|
-
runem/log.py,sha256=dIrocigvIJs1ZGkAzTogXkAK-0ZW3q5FkjpDgLdeW-E,630
|
21
|
-
runem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
22
|
-
runem/report.py,sha256=IedwW9mmJfGC6vKQdKDHQH5eoiYzTWHaaD4a3J4e_Pc,9020
|
23
|
-
runem/run_command.py,sha256=Egl_j4bJ9mwi2JEFCsl0W6WH2IRgIdpMN7qdj8voClQ,6386
|
24
|
-
runem/runem.py,sha256=tQg-4e--GmIBJrX3gP8dAUGQTCP6QOPiSSGwKxVmBac,13336
|
25
|
-
runem/runem_version.py,sha256=MbETwZO2Tb1Y3hX_OYZjKepEMKA1cjNvr-7Cqhz6e3s,271
|
26
|
-
runem/utils.py,sha256=3N_kel9LsriiMq7kOjT14XhfxUOgz4hdDg97wlLKm3U,221
|
27
|
-
runem/types/__init__.py,sha256=6TzF4KV9tDGuDTr2qAXmWWkfDU52WuVlQ8Hcz48aYDk,286
|
28
|
-
runem/types/common.py,sha256=gPMSoJ3yRUYjHnoviRrpSg0gRwsGLFGWGpbTWkq4jX0,279
|
29
|
-
runem/types/errors.py,sha256=rbM5BA6UhY1X7Q0OZLUNsG7JXAjgNFTG5KQuqPNuZm8,103
|
30
|
-
runem/types/filters.py,sha256=8R5fyMssN0ISGBilJhEtbdHFl6OP7uI51WKkB5SH6EA,255
|
31
|
-
runem/types/hooks.py,sha256=lgrv5QAuHCEzr5dXDj4-azNcs63addY9zdrGWj5zv_s,292
|
32
|
-
runem/types/options.py,sha256=y8_hyWYvhalC9-kZbvoDtxm0trZgyyGcswQqfuQy_pM,265
|
33
|
-
runem/types/runem_config.py,sha256=qG_bghm5Nr-ZTbaZbf1v8Fx447V-hgEvvRy5NZ3t-Io,5141
|
34
|
-
runem/types/types_jobs.py,sha256=wqiiBmRIJDbGlKcfOqewHGKx350w0p4_7pysMm7xGmo,4906
|
35
|
-
tests/test_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
36
|
-
tests/test_types/test_public_api.py,sha256=QHiwt7CetQur65JSbFRnOzQxhCJkX5MVLymHHVd_6yc,160
|
37
|
-
runem-0.4.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
|
38
|
-
runem-0.4.0.dist-info/METADATA,sha256=EaVqmVWBeMkJI4tLfI7Nt0A5L3i_OkGCtD_Y8zTJ9kY,5842
|
39
|
-
runem-0.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
|
40
|
-
runem-0.4.0.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
|
41
|
-
runem-0.4.0.dist-info/top_level.txt,sha256=Zu65aVeDPh8WbChU4Mi7-Md4S3XJDPuqdQjEE3DSQno,12
|
42
|
-
runem-0.4.0.dist-info/RECORD,,
|
File without changes
|
File without changes
|