| Name | brundle JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | Run various linters if they are installed. |
| upload_time | 2024-11-29 20:37:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
maintenance
utility
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. Copyright (c) 2024, Janus Heide.
.. All rights reserved.
..
.. Distributed under the "BSD 3-Clause License", see LICENSE.rst.
Brundle
=======
.. image:: https://github.com/janusheide/brundle/actions/workflows/unittests.yml/badge.svg
:target: https://github.com/janusheide/brundle/actions/workflows/unittests.yml
:alt: Unit tests
.. image:: https://img.shields.io/pypi/pyversions/brundle
:alt: PyPI - Python Version
.. image:: https://img.shields.io/librariesio/github/janusheide/brundle
:alt: Libraries.io dependency status for GitHub repo
Runs all the following programs in order, and return 1 if any of them result in an error.
1. isort
2. ruff
3. mypy
Getting Started
---------------
Install and run::
pip install brundle
brundle --help
usage: brundle [-h]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[--log-file LOG_FILE]
[--isort ISORT]
[--ruff RUFF]
[--mypy MYPY]
[-v]
Run available linters.
options:
-h, --help show this help message and exit
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
logging level (default: INFO)
--log-file LOG_FILE pipe loggining to file instead of stdout (default: None)
--isort ISORT runs isort (default: False)
--ruff RUFF runs ruff (default: False)
--mypy MYPY runs mypy (default: False)
-v, --version show program's version number and exit
Or if you want to install all linters that brundle bundles::
pip install brundle[linters]
brundle --help
usage: brundle [-h]
[--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
[--log-file LOG_FILE]
[--isort ISORT]
[--ruff RUFF]
[--mypy MYPY]
[-v]
Run available linters.
options:
-h, --help show this help message and exit
--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
logging level (default: INFO)
--log-file LOG_FILE pipe loggining to file instead of stdout (default: None)
--isort ISORT runs isort (default: True)
--ruff RUFF runs ruff (default: True)
--mypy MYPY runs mypy (default: True)
-v, --version show program's version number and exit
Usage
-----
Run::
brundle
Development
-----------
Setup, run tests and release::
pip install .[dev]
brundle
pytest
bouillon release 1.2.3
Raw data
{
"_id": null,
"home_page": null,
"name": "brundle",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "maintenance, utility",
"author": null,
"author_email": "Janus Heide <janusheide@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/30/85/025cc08fae91019de9488190c955621cf25e2d4db1bf0e2dd7a146a67e7e/brundle-1.3.0.tar.gz",
"platform": null,
"description": ".. Copyright (c) 2024, Janus Heide.\n.. All rights reserved.\n..\n.. Distributed under the \"BSD 3-Clause License\", see LICENSE.rst.\n\nBrundle\n=======\n\n.. image:: https://github.com/janusheide/brundle/actions/workflows/unittests.yml/badge.svg\n :target: https://github.com/janusheide/brundle/actions/workflows/unittests.yml\n :alt: Unit tests\n\n.. image:: https://img.shields.io/pypi/pyversions/brundle\n :alt: PyPI - Python Version\n\n.. image:: https://img.shields.io/librariesio/github/janusheide/brundle\n :alt: Libraries.io dependency status for GitHub repo\n\n\nRuns all the following programs in order, and return 1 if any of them result in an error.\n\n 1. isort\n 2. ruff\n 3. mypy\n\n\nGetting Started\n---------------\n\nInstall and run::\n\n pip install brundle\n brundle --help\n\n usage: brundle [-h]\n [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]\n [--log-file LOG_FILE]\n [--isort ISORT]\n [--ruff RUFF]\n [--mypy MYPY]\n [-v]\n\n Run available linters.\n\n options:\n -h, --help show this help message and exit\n --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}\n logging level (default: INFO)\n --log-file LOG_FILE pipe loggining to file instead of stdout (default: None)\n --isort ISORT runs isort (default: False)\n --ruff RUFF runs ruff (default: False)\n --mypy MYPY runs mypy (default: False)\n -v, --version show program's version number and exit\n\n\nOr if you want to install all linters that brundle bundles::\n\n pip install brundle[linters]\n brundle --help\n\n usage: brundle [-h]\n [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}]\n [--log-file LOG_FILE]\n [--isort ISORT]\n [--ruff RUFF]\n [--mypy MYPY]\n [-v]\n\n Run available linters.\n\n options:\n -h, --help show this help message and exit\n --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}\n logging level (default: INFO)\n --log-file LOG_FILE pipe loggining to file instead of stdout (default: None)\n --isort ISORT runs isort (default: True)\n --ruff RUFF runs ruff (default: True)\n --mypy MYPY runs mypy (default: True)\n -v, --version show program's version number and exit\n\n\nUsage\n-----\n\nRun::\n\n brundle\n\n\nDevelopment\n-----------\n\nSetup, run tests and release::\n\n pip install .[dev]\n brundle\n pytest\n bouillon release 1.2.3\n",
"bugtrack_url": null,
"license": null,
"summary": "Run various linters if they are installed.",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/janusheide/brundle/blob/main/NEWS.rst",
"Homepage": "https://github.com/janusheide/brundle",
"Repository": "https://github.com/janusheide/brundle"
},
"split_keywords": [
"maintenance",
" utility"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e42690113ecda16f23984a3901b8cfa434cf085a244b00df4e0e9022a3bb77b",
"md5": "a340ec29d2842844b21212ce5dc62611",
"sha256": "64e281aacb3493dbc81eca81f3a07f121770ba92e595178d42ada73b6dd81161"
},
"downloads": -1,
"filename": "brundle-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a340ec29d2842844b21212ce5dc62611",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5244,
"upload_time": "2024-11-29T20:37:19",
"upload_time_iso_8601": "2024-11-29T20:37:19.038537Z",
"url": "https://files.pythonhosted.org/packages/0e/42/690113ecda16f23984a3901b8cfa434cf085a244b00df4e0e9022a3bb77b/brundle-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3085025cc08fae91019de9488190c955621cf25e2d4db1bf0e2dd7a146a67e7e",
"md5": "060b7969946350057fb965ef681a08e6",
"sha256": "bc6fde192f0e7f8889f283603a6da7b06be7e977fc8228cbee72e54b30540a30"
},
"downloads": -1,
"filename": "brundle-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "060b7969946350057fb965ef681a08e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7655,
"upload_time": "2024-11-29T20:37:31",
"upload_time_iso_8601": "2024-11-29T20:37:31.741857Z",
"url": "https://files.pythonhosted.org/packages/30/85/025cc08fae91019de9488190c955621cf25e2d4db1bf0e2dd7a146a67e7e/brundle-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-29 20:37:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "janusheide",
"github_project": "brundle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "brundle"
}
