brundle

Name	brundle JSON
Version	1.0.0 JSON
	download
home_page	None
Summary	Run various linters if they are installed.
upload_time	2024-10-01 08:42:03
maintainer	None
docs_url	None
author	None
requires_python	None
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 various linters if they are installed.

Getting Started
---------------

Install and run::

    pip install brundle
    brundle --help

Or if you want to install all linters that brundle will run::

    pip install brundle[linters]
    brundle --help

Usage
-----

Run::

    brundle

Runs all the following programs in order, and return 1 if any of them result in an error.

    1. licensecheck
    2. isort
    3. ruff
    4. mypy


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": null,
    "maintainer_email": null,
    "keywords": "maintenance, utility",
    "author": null,
    "author_email": "Janus Heide <janusheide@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/be/e9/6527210da6aa2a7230f16f1f0104813150f2aedc63c2956c6f07abd80912/brundle-1.0.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 various linters if they are installed.\n\nGetting Started\n---------------\n\nInstall and run::\n\n    pip install brundle\n    brundle --help\n\nOr if you want to install all linters that brundle will run::\n\n    pip install brundle[linters]\n    brundle --help\n\nUsage\n-----\n\nRun::\n\n    brundle\n\nRuns all the following programs in order, and return 1 if any of them result in an error.\n\n    1. licensecheck\n    2. isort\n    3. ruff\n    4. mypy\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.0.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": "28058dc7b1b0af3c91cc8ae25a8b4516fe77fc0955948ee9d4c02a1da3746f93",
                "md5": "b40847806e9127d0830d7a3d0c670e04",
                "sha256": "ddec0bad82766d3d4ddb0f3377455b91afc3dfab9f18c509805d1a1a30d304a3"
            },
            "downloads": -1,
            "filename": "brundle-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b40847806e9127d0830d7a3d0c670e04",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4807,
            "upload_time": "2024-10-01T08:42:01",
            "upload_time_iso_8601": "2024-10-01T08:42:01.517233Z",
            "url": "https://files.pythonhosted.org/packages/28/05/8dc7b1b0af3c91cc8ae25a8b4516fe77fc0955948ee9d4c02a1da3746f93/brundle-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bee96527210da6aa2a7230f16f1f0104813150f2aedc63c2956c6f07abd80912",
                "md5": "af494bac8d1c7fda327f187701d2c3b6",
                "sha256": "843aa90a116cd74bce6f06799304c88e592c26c80ad9f956f27aa7dcc7521a9b"
            },
            "downloads": -1,
            "filename": "brundle-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af494bac8d1c7fda327f187701d2c3b6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6712,
            "upload_time": "2024-10-01T08:42:03",
            "upload_time_iso_8601": "2024-10-01T08:42:03.088292Z",
            "url": "https://files.pythonhosted.org/packages/be/e9/6527210da6aa2a7230f16f1f0104813150f2aedc63c2956c6f07abd80912/brundle-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-01 08:42:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "janusheide",
    "github_project": "brundle",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "brundle"
}