{"id":16451392,"url":"https://github.com/Red-Green-Blue2/jenkins_badges","last_synced_at":"2025-03-23T09:30:42.147Z","repository":{"id":56209357,"uuid":"95612768","full_name":"jeremyarr/jenkins_badges","owner":"jeremyarr","description":"a small flask app that serves dynamic badge images based on data from Jenkins CI","archived":false,"fork":false,"pushed_at":"2020-11-20T11:07:54.000Z","size":58,"stargazers_count":11,"open_issues_count":3,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-12T10:08:43.701Z","etag":null,"topics":["cobertura","coverage","flask","github-badge","jenkins","python","python2-7","python3","python3-6","shieldsio"],"latest_commit_sha":null,"homepage":"https://jenkins-badges.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeremyarr.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-28T00:40:06.000Z","updated_at":"2022-09-01T22:39:23.000Z","dependencies_parsed_at":"2022-08-15T14:40:57.100Z","dependency_job_id":null,"html_url":"https://github.com/jeremyarr/jenkins_badges","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyarr%2Fjenkins_badges","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyarr%2Fjenkins_badges/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyarr%2Fjenkins_badges/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyarr%2Fjenkins_badges/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeremyarr","download_url":"https://codeload.github.com/jeremyarr/jenkins_badges/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221848631,"owners_count":16891305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cobertura","coverage","flask","github-badge","jenkins","python","python2-7","python3","python3-6","shieldsio"],"created_at":"2024-10-11T10:08:36.597Z","updated_at":"2025-03-23T09:30:40.214Z","avatar_url":"https://github.com/jeremyarr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: docs/_static/logo_full.png\n\n.. image:: https://img.shields.io/pypi/v/jenkins-badges.svg\n    :target: https://pypi.python.org/pypi/jenkins-badges\n\n.. image:: https://img.shields.io/pypi/l/jenkins-badges.svg\n    :target: https://pypi.python.org/pypi/jenkins-badges\n\n.. image:: https://img.shields.io/pypi/pyversions/jenkins-badges.svg\n    :target: https://pypi.python.org/pypi/jenkins-badges\n\n.. image::  https://img.shields.io/pypi/status/jenkins-badges.svg\n    :target: https://pypi.python.org/pypi/jenkins-badges\n\n.. image:: https://img.shields.io/pypi/implementation/jenkins-badges.svg\n    :target: https://pypi.python.org/pypi/jenkins-badges\n\n\n`jenkins_badges` is a small flask app that serves dynamic badge images based on data from Jenkins CI.\n\nSupported badges\n-----------------\n+----------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------+\n|Endpoint              | Examples                                                                                                      | Default                          |\n+======================+===============================================================================================================+==================================+\n|coverage/\u003cJenkinsJob\u003e | .. image:: https://cdn.rawgit.com/jeremyarr/jenkins_badges/master/docs/_static/coverage_green.svg             | 80% +                            |\n+                      +---------------------------------------------------------------------------------------------------------------+----------------------------------+\n|                      | .. image:: https://cdn.rawgit.com/jeremyarr/jenkins_badges/master/docs/_static/coverage_yellow.svg            | 20%-80%                          |\n+                      +---------------------------------------------------------------------------------------------------------------+----------------------------------+\n|                      | .. image:: https://cdn.rawgit.com/jeremyarr/jenkins_badges/master/docs/_static/coverage_red.svg               | \u003c 20%                            |\n+                      +---------------------------------------------------------------------------------------------------------------+----------------------------------+\n|                      | .. image:: https://cdn.rawgit.com/jeremyarr/jenkins_badges/master/docs/_static/coverage_error.svg             | error getting coverage data      |\n+----------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------+\n\nFeatures\n-----------------\n\n- Badge won't get stale.\n- Configurable coverage level colours\n- Compatible with private Jenkins instances\n- WSGI server compatible\n\nGet it now\n-----------\n\nWith pip:\n**********\n\n.. code-block:: bash\n\n    $ pip install jenkins_badges\n\nJenkins Requirements\n----------------------\n- The `anonymous` user has read access or supply `jenkins_badges` with the credentials of a user who does (see below).\n- `Cobertura plugin \u003chttps://wiki.jenkins.io/display/JENKINS/Cobertura+Plugin\u003e`_\n\n\nQuickstart\n----------\n\n1. create app\n\n.. code-block:: python\n\n    import jenkins_badges\n\n    #path to your jenkins instance\n    base_url = \"https://example.com/jenkins\" \n\n    # not required if anonymous jenkins user has read access\n    username = \"apiuser\" #a user with read access\n    token = \"6c3bde145bcda49402b6914f2353a734\" #user's token\n\n    app = jenkins_badges.create_app(base_url=base_url,\n                                    username=username,\n                                    token=token)\n\n\n2. run it!\n\n.. code-block:: python\n\n    app.run()\n\nOutput:\n\n.. code-block:: console\n\n    * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n\n\n\n2. Your coverage badge image should be accessible at `http://127.0.0.1:5000/coverage/\u003cJenkinsJobName\u003e`\n\n\nMore at https://jenkins-badges.readthedocs.io\n----------------------------------------------\n\nProject Links\n-------------\n\n- Docs: https://jenkins-badges.readthedocs.io/\n- Changelog: https://jenkins-badges.readthedocs.io/en/latest/changelog.html\n- PyPI: https://pypi.python.org/pypi/jenkins-badges\n- Issues: https://github.com/jeremyarr/jenkins_badges/issues\n\nKudos\n-----\n\n- Idea came from mnpk's `jenkins-coverage-badge \u003chttps://github.com/mnpk/jenkins-coverage-badge\u003e`_ written in nodeJS.\n- `shields.io \u003chttps://shields.io/\u003e`_ for providing scalable badges over a clean API\n- `Jenkins \u003chttps://jenkins.io/\u003e`_ for being...jenkins\n\nLicense\n-------\n\nMIT licensed. See the bundled `LICENSE \u003chttps://github.com/jeremyarr/jenkins_badges/blob/master/LICENSE\u003e`_ file for more details.\n  \n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRed-Green-Blue2%2Fjenkins_badges","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRed-Green-Blue2%2Fjenkins_badges","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRed-Green-Blue2%2Fjenkins_badges/lists"}