| Name | detox-jar JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Command line automation tool in pure Python |
| upload_time | 2024-11-14 10:50:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 Kaloyan Ivanov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
automation
cli tool
command line runner
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://github.com/kaliv0/detox-jar/blob/main/assets/detox-jar.jpg?raw=true" width="250" alt="Detox jar">
</p>
# Detox jar
[](https://pypi.org/project/detox-jar/)
[](https://pepy.tech/projects/detox-jar)
<br>Command line automation tool in pure Python
---------------------------
### How to use
- Describe jobs as tables/dictionaries in a config file called 'detox' (choose between .toml, .yaml or .json format).
<br>(Put the config inside the root directory of your project)
```toml
# detox.toml
[test]
description = "test project"
dependencies = ["pytest", "pytest-cov"]
commands = "pytest -vv --disable-warnings -s --cache-clear"
```
```yaml
# detox.yaml
test:
description: test project
dependencies:
- pytest
- pytest-cov
commands:
- pytest -vv --disable-warnings -s --cache-clear
```
- <i>description</i> and <i>dependencies</i> could be optional but not <i>commands</i>
```toml
# detox.toml
[no-deps]
commands = "echo 'Hello world'"
```
(in json)
```json
"no-deps": {
"commands": "echo 'Hello world'"
}
```
- <i>dependencies</i> and <i>commands</i> could be strings or (in case of more than one) a list of strings
```toml
# detox.toml
commands = ["ruff check --fix", "ruff format --line-length=100 ."]
```
```yaml
# detox.yaml
commands:
- ruff check --fix
- ruff format --line-length=100 .
```
- You could provide a [run] table inside the config file with a <i>'suite'</i> - list of selected jobs to run
```toml
[run]
suite = ["lint", "format", "test"]
```
```json
"run": {
"suite": [
"lint",
"format",
"test",
"no-deps"
]
}
```
---------------------------
- Run the tool in the terminal with a simple <b>'detox'</b> command
```shell
$ detox
```
```shell
(logs omitted...)
$ All jobs succeeded! ['lint', 'format', 'test']
Detoxing took: 14.088007061000098
```
- In case of failing jobs you get general stats
```shell
(logs omitted...)
$ Unsuccessful detoxing took: 13.532951637999759
Failed jobs: ['format']
Successful jobs: ['lint', 'test']
```
or
```shell
$ Unsuccessful detoxing took: 8.48367640699962
Failed jobs: ['format']
Successful jobs: ['lint']
Skipped jobs: ['test']
```
---------------------------
- You could run specific jobs in the command line
```shell
$ detox -j lint
```
or a list of jobs
```shell
$ detox -j lint format
```
<b>NB:</b> If there is a <i>'run'</i> table in the config file the jobs specified in the command line take precedence
Raw data
{
"_id": null,
"home_page": null,
"name": "detox-jar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "automation, cli tool, command line runner",
"author": null,
"author_email": "Kaloyan Ivanov <kaloyan.ivanov88@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/06/e6/c9c4a82531e8b9908319f78125b441c6ee3187c613d1b82880f531c905a6/detox_jar-1.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/kaliv0/detox-jar/blob/main/assets/detox-jar.jpg?raw=true\" width=\"250\" alt=\"Detox jar\">\n</p>\n\n# Detox jar\n\n\n[](https://pypi.org/project/detox-jar/)\n[](https://pepy.tech/projects/detox-jar)\n\n<br>Command line automation tool in pure Python\n\n---------------------------\n### How to use\n- Describe jobs as tables/dictionaries in a config file called 'detox' (choose between .toml, .yaml or .json format).\n<br>(Put the config inside the root directory of your project)\n```toml\n# detox.toml\n[test]\ndescription = \"test project\"\ndependencies = [\"pytest\", \"pytest-cov\"]\ncommands = \"pytest -vv --disable-warnings -s --cache-clear\"\n```\n```yaml\n# detox.yaml\ntest:\n description: test project\n dependencies:\n - pytest\n - pytest-cov\n commands:\n - pytest -vv --disable-warnings -s --cache-clear\n```\n\n- <i>description</i> and <i>dependencies</i> could be optional but not <i>commands</i>\n```toml\n# detox.toml\n[no-deps]\ncommands = \"echo 'Hello world'\"\n```\n(in json)\n```json\n\"no-deps\": {\n \"commands\": \"echo 'Hello world'\"\n}\n```\n\n- <i>dependencies</i> and <i>commands</i> could be strings or (in case of more than one) a list of strings\n```toml\n# detox.toml\ncommands = [\"ruff check --fix\", \"ruff format --line-length=100 .\"]\n```\n```yaml\n# detox.yaml\ncommands:\n - ruff check --fix\n - ruff format --line-length=100 .\n```\n\n- You could provide a [run] table inside the config file with a <i>'suite'</i> - list of selected jobs to run\n```toml\n[run]\nsuite = [\"lint\", \"format\", \"test\"]\n```\n```json\n\"run\": {\n \"suite\": [\n \"lint\",\n \"format\",\n \"test\",\n \"no-deps\"\n ]\n}\n```\n---------------------------\n- Run the tool in the terminal with a simple <b>'detox'</b> command\n```shell\n$ detox\n```\n```shell\n(logs omitted...)\n$ All jobs succeeded! ['lint', 'format', 'test']\nDetoxing took: 14.088007061000098\n```\n- In case of failing jobs you get general stats\n```shell\n(logs omitted...)\n$ Unsuccessful detoxing took: 13.532951637999759\nFailed jobs: ['format']\nSuccessful jobs: ['lint', 'test']\n```\nor\n```shell\n$ Unsuccessful detoxing took: 8.48367640699962\nFailed jobs: ['format']\nSuccessful jobs: ['lint']\nSkipped jobs: ['test']\n```\n---------------------------\n- You could run specific jobs in the command line\n```shell\n$ detox -j lint\n```\nor a list of jobs\n```shell\n$ detox -j lint format\n```\n<b>NB:</b> If there is a <i>'run'</i> table in the config file the jobs specified in the command line take precedence\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Kaloyan Ivanov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command line automation tool in pure Python",
"version": "1.1.0",
"project_urls": {
"repository": "https://github.com/kaliv0/detox-jar.git"
},
"split_keywords": [
"automation",
" cli tool",
" command line runner"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "058658c52d8ad67f98a645a95f617fff26b0fb5899cb97dbb260c4529d8d36a6",
"md5": "bffbe9e964fbba68f80c21898566f411",
"sha256": "0df16b23d4efa2cb593705960ecefa8d645f633291bcf257d11ad3f131fd9ca3"
},
"downloads": -1,
"filename": "detox_jar-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bffbe9e964fbba68f80c21898566f411",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7185,
"upload_time": "2024-11-14T10:50:35",
"upload_time_iso_8601": "2024-11-14T10:50:35.494000Z",
"url": "https://files.pythonhosted.org/packages/05/86/58c52d8ad67f98a645a95f617fff26b0fb5899cb97dbb260c4529d8d36a6/detox_jar-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06e6c9c4a82531e8b9908319f78125b441c6ee3187c613d1b82880f531c905a6",
"md5": "702a58ee545bb22013150c1d27006dbf",
"sha256": "9682fcb96b620f1ac16eddeabc2c3b9403348d9720c5ded7aaf66a8e53007211"
},
"downloads": -1,
"filename": "detox_jar-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "702a58ee545bb22013150c1d27006dbf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 5967,
"upload_time": "2024-11-14T10:50:36",
"upload_time_iso_8601": "2024-11-14T10:50:36.722410Z",
"url": "https://files.pythonhosted.org/packages/06/e6/c9c4a82531e8b9908319f78125b441c6ee3187c613d1b82880f531c905a6/detox_jar-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 10:50:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kaliv0",
"github_project": "detox-jar",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "detox-jar"
}
