{"id":37022517,"url":"https://github.com/touchbit/shields4j","last_synced_at":"2026-01-14T02:41:33.149Z","repository":{"id":45423356,"uuid":"181437678","full_name":"touchbit/shields4j","owner":"touchbit","description":"Java client for shields.io","archived":false,"fork":false,"pushed_at":"2021-12-14T20:37:48.000Z","size":170,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-07T16:03:51.878Z","etag":null,"topics":["java","shields4j","shieldsio","shieldsio-client","testng","testng-listners"],"latest_commit_sha":null,"homepage":"https://shields.io","language":"Java","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/touchbit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-15T07:46:03.000Z","updated_at":"2020-09-15T17:47:36.000Z","dependencies_parsed_at":"2022-08-19T18:50:38.062Z","dependency_job_id":null,"html_url":"https://github.com/touchbit/shields4j","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/touchbit/shields4j","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/touchbit%2Fshields4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/touchbit%2Fshields4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/touchbit%2Fshields4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/touchbit%2Fshields4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/touchbit","download_url":"https://codeload.github.com/touchbit/shields4j/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/touchbit%2Fshields4j/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["java","shields4j","shieldsio","shieldsio-client","testng","testng-listners"],"created_at":"2026-01-14T02:41:32.280Z","updated_at":"2026-01-14T02:41:33.128Z","avatar_url":"https://github.com/touchbit.png","language":"Java","readme":"Shields4j |Master| |MavenCentral| |DocumentationStatus| |AlertStatus| |Coverage|\n=======================================\n\n.. |Master| image:: https://github.com/touchbit/shields4j/workflows/Master/badge.svg?style=plastic\n    :target: https://github.com/touchbit/shields4j/actions?query=workflow%3Amaster\n\n.. |MavenCentral| image:: https://maven-badges.herokuapp.com/maven-central/org.touchbit.shields4j/shields4j-parent/badge.svg\n    :target: https://mvnrepository.com/artifact/org.touchbit.shields4j\n\n.. |DocumentationStatus| image:: https://readthedocs.org/projects/shields4j/badge/?version=master\n    :target: https://shields4j.readthedocs.io\n\n.. |AlertStatus| image:: https://sonarcloud.io/api/project_badges/measure?project=org.touchbit.shields4j%3Ashields4j-parent\u0026metric=alert_status\n    :target: https://sonarcloud.io/dashboard?id=org.touchbit.shields4j%3Ashields4j-parent\n\n.. |Coverage| image:: https://sonarcloud.io/api/project_badges/measure?project=org.touchbit.shields4j%3Ashields4j-parent\u0026metric=coverage\u0026blinking=true\n    :target: https://sonarcloud.io/component_measures?id=org.touchbit.shields4j%3Ashields4j-parent\u0026metric=coverage\n\nLightweight java HTTP-client for the `shields.io`_ service.\n\n.. _shields.io: https://shields.io/\n\nFull documentation is available on the `shields4j.readthedocs.io`_\n\n.. _shields4j.readthedocs.io: https://shields4j.readthedocs.io/\n\nBriefly\n-------\n\nJava client\n^^^^^^^^^^^\n\nAdd dependency\n\n.. code:: xml\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.touchbit.shields4j\u003c/groupId\u003e\n        \u003cartifactId\u003eclient\u003c/artifactId\u003e\n        \u003cversion\u003e${shields4j.version}\u003c/version\u003e\n    \u003c/dependency\u003e\n\nIf you need to get Shields4j versions that are not uploaded to maven central (snapshot/staging), add the Sonatype repository to your pom.xml\n\n.. code:: xml\n\n    \u003crepositories\u003e\n        \u003crepository\u003e\n            \u003cid\u003eSonatypeNexus\u003c/id\u003e\n            \u003curl\u003ehttps://oss.sonatype.org/content/groups/staging/\u003c/url\u003e\n        \u003c/repository\u003e\n    \u003c/repositories\u003e\n\nMinimal |minimal|\n\n.. |minimal| image:: .docs/img/minimal.svg\n\n.. code:: java\n\n    class Example {\n        public static void main (String[] arg) {\n            new ShieldsIO()\n                .withLabel(\"Shields4J\")\n                .withMessage(\"1.0\")\n                .writeShieldToFile(\"minimal.svg\");\n        }\n    }\n\nWith logo and color background |withlogo|\n\n.. |withlogo| image:: .docs/img/with-logo.svg\n\n.. code:: java\n\n    class Example {\n        public static void main (String[] arg) {\n            new ShieldsIO()\n                .withLabel(\"Shields4J\")\n                .withLabelColor(Color.BLUE)\n                .withMessage(\"with Raspberry PI logo\")\n                .withMessageColor(Color.GREEN)\n                .withStyle(Style.POPOUT)\n                .withLogo(Logo.RASPBERRY_PI)\n                .withLogoColor(Color.RED)\n                .withLogoWidth(30)\n                .writeShieldToFile(\"with-logo.svg\");\n        }\n    }\n\nWith custom logo and color background |withcustomlogo|\n\n.. |withcustomlogo| image:: .docs/img/with-custom-logo.svg\n\n.. code:: java\n\n    class Example {\n        public static void main (String[] arg) {\n             new ShieldsIO()\n                .withLabel(\"Shields4J\")\n                .withLabelColor(Color.BLUE)\n                .withMessage(\"with custom logo\")\n                .withMessageColor(Color.GREEN)\n                .withStyle(Style.POPOUT)\n                .withBase64Logo(new File(\"docs/img/status_success.svg\"))\n                .writeShieldToFile(\"with-custom-logo.svg\");\n        }\n    }\n\nTestNG listener\n^^^^^^^^^^^^^^^\n\nAdd dependency\n\n.. code:: xml\n\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.touchbit.shields4j\u003c/groupId\u003e\n        \u003cartifactId\u003etestng\u003c/artifactId\u003e\n        \u003cversion\u003e${shields4j.version}\u003c/version\u003e\n    \u003c/dependency\u003e\n\nAdd IShieldsListener to testNG |iteststotal| |itestssuccesspercent|\n\n.. |iteststotal| image:: .docs/img/TestNG-iTests-total.svg\n\n.. |itestssuccesspercent| image:: .docs/img/TestNG-iTests-success-percent.svg\n\n.. code:: java\n\n    class Example {\n        public static void main (String[] arg) {\n             TestNG testNG = new TestNG();\n             testNG.addListener(new IShieldsListener());\n        }\n    }\n\nor add IShieldsListener in your testng.xml file\n\n.. code:: xml\n\n    \u003csuite\u003e\n      \u003clisteners\u003e\n        \u003clistener class-name=\"org.touchbit.shields4j.testng.IShieldsListener\" /\u003e\n      \u003c/listeners\u003e\n    \u003c/suite\u003e\n\nTo customize the prefixes, create your own listener inherited from IShieldsListener |integrationtesttotal| |integrationtestsuccesspercent|\n\n.. |integrationtesttotal| image:: .docs/img/testng-Integration-test-total.svg\n\n.. |integrationtestsuccesspercent| image:: .docs/img/testng-Integration-test-success-percent.svg\n\n.. code:: java\n\n    public class ShieldsListener extends IShieldsListener {\n        public ShieldsListener() {\n            withLabelPefix(\"Integration test\");\n            withFilePefix(\"testng\");\n        }\n    }\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftouchbit%2Fshields4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftouchbit%2Fshields4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftouchbit%2Fshields4j/lists"}