{"id":20883977,"url":"https://github.com/getgauge/gauge-python","last_synced_at":"2025-05-16T07:00:18.867Z","repository":{"id":39461674,"uuid":"51195004","full_name":"getgauge/gauge-python","owner":"getgauge","description":"Python language runner for Gauge","archived":false,"fork":false,"pushed_at":"2025-05-12T07:15:57.000Z","size":736,"stargazers_count":92,"open_issues_count":9,"forks_count":38,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-05-12T07:42:42.330Z","etag":null,"topics":["gauge","gauge-plugin","gauge-python","language-runner","python","test-automation"],"latest_commit_sha":null,"homepage":"","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/getgauge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-02-06T08:16:28.000Z","updated_at":"2025-05-12T07:16:00.000Z","dependencies_parsed_at":"2022-07-04T08:44:20.577Z","dependency_job_id":"249b2c28-6502-40e2-9004-94b6c9f4e110","html_url":"https://github.com/getgauge/gauge-python","commit_stats":{"total_commits":439,"total_committers":28,"mean_commits":"15.678571428571429","dds":0.5876993166287017,"last_synced_commit":"1c6126ef09c94b735094fe552815b65c00329771"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getgauge%2Fgauge-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getgauge","download_url":"https://codeload.github.com/getgauge/gauge-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485025,"owners_count":22078764,"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":["gauge","gauge-plugin","gauge-python","language-runner","python","test-automation"],"created_at":"2024-11-18T08:08:40.798Z","updated_at":"2025-05-16T07:00:18.758Z","avatar_url":"https://github.com/getgauge.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gauge-Python\n\n[![Actions Status](https://github.com/getgauge/gauge-python/actions/workflows/tests.yml/badge.svg)](https://github.com/getgauge/gauge-python/actions)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)\n\nThis project adds Python [language plugin](https://docs.gauge.org/plugins.html#language-reporting-plugins) for [gauge](http://gauge.org).\n\n## Getting started\n\n### Pre-requisite\n\n- [Gauge](https://gauge.org/index.html)\n- [Python](https://www.python.org/)\n- [Pip](https://pip.pypa.io/en/stable/)\n\n### Installation\n\n```\ngauge install python\n```\n\n### Create a gauge-python project\n\n```\ngauge init python\n```\n\n### Run tests\n\n```\ngauge run specs\n```\n\n### Useful links\n\n- [User Docs](https://docs.gauge.org)\n\n### Alternate Installation options\n\n#### Install specific version\n```\ngauge install python -v 0.2.3\n[pip / pip3] install getgauge\n```\n\n### Offline installation\n* Download the plugin from [Releases](https://github.com/getgauge/gauge-python/releases)\n```\ngauge install python --file gauge-python-0.2.3.zip\n[pip / pip3] install getgauge\n```\n\n#### Build from Source\n\n##### Pre-Requisites\n\n* [Golang](http://golang.org/)\n\n##### Installing package dependencies\n```\npip install -r requirements.txt\n```\n\n##### Tests\n```\npython build.py --test\n```\n\n##### Tests Coverage\n```\npython build.py --test\ncoverage report -m\n```\n\n##### Installing\n```\npython build.py --install\n```\n\n##### Creating distributable\n```\npython build.py --dist\n```\n\nThis will create a .zip file in bin directory and a .tar.gz file in dist directory.\n\n## Deployment\n\nOnly contributors with push access can create a deployment.\n\nThe deployment process is managed via Github Actions.\n\nFollow these steps to deploy gauge-python.\n\n* Create a Personal Access Token in Github with `repo:public_repo` scope (skip this step if you already have a PAT).\n* Run `GITHUB_TOKEN={Your token} sh release.sh` in `gauge-python` dir. This will trigger a deployment workflow on Github Actions. This workflow creates a release draft with all required assets and information.\n* Visit to the release draft, analyze and update the contents (remove unnecessary entries, mention Contributors, remove dependabot PR entries).\n* Publish the draft release.\n* Once the draft is published it will trigger another workflow on Github Actions, which will perform all the Post release tasks, In case of gauge-python it will upload the `getgauge` python packge to `PyPi`.\n* Once it's done please update the new release information in [gauge-repository](https://github.com/getgauge/gauge-repository/blob/master/python-install.json)\n* That's it. Now the release can be announced on the required community platforms (chat, google group etc.)\n\n\n## Examples\n\n- Selenium: This project serves as an example for writing automation using Gauge. It uses selenium and various Gauge/Gauge-Python features. For more details, Check out the [gauge-example-python](https://github.com/getgauge-examples/python-selenium) repository.\n\n- Selenium and REST API: This project shows an example of how to setup Gauge, Gauge Python and [Magento](https://magento.com/) to test REST API. For more details, Check out the [blog](https://angbaird.com/2016/11/09/selenium-and-rest-api-testing-with-gauge/) or [gauge-magento-test](https://github.com/angb/gauge-magento-test) repository.\n\n\n## License\n\nThe Gauge-Python is an open-sourced software licensed under the `MIT license`.\n\n## Copyright\n\nCopyright 2018 ThoughtWorks, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgauge%2Fgauge-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetgauge%2Fgauge-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetgauge%2Fgauge-python/lists"}