{"id":13608182,"url":"https://github.com/xvik/gradle-use-python-plugin","last_synced_at":"2025-08-21T18:33:08.259Z","repository":{"id":38431040,"uuid":"113813718","full_name":"xvik/gradle-use-python-plugin","owner":"xvik","description":"Use python modules in gradle build","archived":false,"fork":false,"pushed_at":"2025-08-19T10:03:54.000Z","size":2647,"stargazers_count":72,"open_issues_count":1,"forks_count":19,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-19T12:20:21.053Z","etag":null,"topics":["docker","gradle","gradle-plugin","python","virtualenv"],"latest_commit_sha":null,"homepage":"https://xvik.github.io/gradle-use-python-plugin/","language":"Groovy","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/xvik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2017-12-11T04:52:52.000Z","updated_at":"2025-08-19T10:03:51.000Z","dependencies_parsed_at":"2023-12-22T07:27:51.533Z","dependency_job_id":"10f59be1-594e-4e00-8f38-167eb1a841e6","html_url":"https://github.com/xvik/gradle-use-python-plugin","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/xvik/gradle-use-python-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-use-python-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-use-python-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-use-python-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-use-python-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xvik","download_url":"https://codeload.github.com/xvik/gradle-use-python-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-use-python-plugin/sbom","scorecard":{"id":465311,"data":{"date":"2025-07-07","repo":{"name":"github.com/xvik/gradle-use-python-plugin","commit":"a37159b27a8b1df47b94617cd5704b03d728ce36"},"scorecard":{"version":"v5.2.1-18-gbb9c347d","commit":"bb9c347dff6349d986baab6578a46d68a5524c62"},"score":4.1,"checks":[{"name":"Code-Review","score":-1,"reason":"Found no human activity in the last 15 changesets","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#packaging"}},{"name":"Maintained","score":4,"reason":"4 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/CI.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/xvik/gradle-use-python-plugin/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/xvik/gradle-use-python-plugin/CI.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/xvik/gradle-use-python-plugin/CI.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/xvik/gradle-use-python-plugin/CI.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:49","Warn: pipCommand not pinned by hash: .github/workflows/CI.yml:51","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   2 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/bb9c347dff6349d986baab6578a46d68a5524c62/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T12:20:31.246Z","repository_id":38431040,"created_at":"2025-08-19T12:20:31.246Z","updated_at":"2025-08-19T12:20:31.246Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271157701,"owners_count":24709066,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"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":["docker","gradle","gradle-plugin","python","virtualenv"],"created_at":"2024-08-01T19:01:24.915Z","updated_at":"2025-08-21T18:33:07.850Z","avatar_url":"https://github.com/xvik.png","language":"Groovy","funding_links":[],"categories":["Groovy"],"sub_categories":[],"readme":"# Gradle use-python plugin\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://www.opensource.org/licenses/MIT)\n[![CI](https://github.com/xvik/gradle-use-python-plugin/actions/workflows/CI.yml/badge.svg)](https://github.com/xvik/gradle-use-python-plugin/actions/workflows/CI.yml)\n[![Appveyor build status](https://ci.appveyor.com/api/projects/status/github/xvik/gradle-use-python-plugin?svg=true)](https://ci.appveyor.com/project/xvik/gradle-use-python-plugin)\n[![codecov](https://codecov.io/gh/xvik/gradle-use-python-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/xvik/gradle-use-python-plugin)\n\n**DOCUMENTATION**: https://xvik.github.io/gradle-use-python-plugin/\n\n### About\n\nPlugin **does not install python and pip** itself and use globally installed python (by default). \nIt's easier to prepare python manually because python have good compatibility (from user perspective) and does not need to \nbe updated often.\n\nAlso, plugin could run python inside docker container to avoid local python installation.\n\nThe only plugin intention is to simplify python usage from gradle. By default, plugin creates python virtualenv\ninside the project and installs all modules there so each project has its own python (copy) and could not be \naffected by other projects or system changes.\n\nFeatures:\n\n* Works with directly installed python or docker container (with python)\n* Creates local (project-specific) virtualenv (project-specific python copy)\n* Installs required pip modules (venv by default (with fallback to virtualenv), but could be global installation) \n* Support requirements.txt file (limited by default)\n* Compatible with gradle configuration cache\n* Could be used as basement for building plugins for specific python modules (like \n[mkdocs plugin](https://github.com/xvik/gradle-mkdocs-plugin))\n\n**[Who's using (usage examples)](https://github.com/xvik/gradle-use-python-plugin/discussions/18)**\n\n##### Summary\n\n* Configuration: `python`\n* Tasks:\n    - `checkPython` - validate python installation (and create virtualenv if required)\n    - `cleanPython` - clean created python environment\n    - `pipInstall` - install declared pip modules\n    - `pipUpdates` - show the latest available versions for the registered modules\n    - `pipList` - show all installed modules (the same as pipInstall shows after installation)\n    - `type:PythonTask` - call python command/script/module\n    - `type:PipInstallTask` - may be used for custom pip modules installation workflow\n\n### Setup\n\n[![Maven Central](https://img.shields.io/maven-central/v/ru.vyarus/gradle-use-python-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/ru.vyarus/gradle-use-python-plugin)\n[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/ru/vyarus/use-python/ru.vyarus.use-python.gradle.plugin/maven-metadata.xml.svg?colorB=007ec6\u0026label=plugins%20portal)](https://plugins.gradle.org/plugin/ru.vyarus.use-python)\n\n```groovy\nbuildscript {\n    repositories {\n        mavenCentral()\n    }\n    dependencies {\n        classpath 'ru.vyarus:gradle-use-python-plugin:4.1.0'\n    }\n}\napply plugin: 'ru.vyarus.use-python'\n```\n\nOR \n\n```groovy\nplugins {\n    id 'ru.vyarus.use-python' version '4.1.0'\n}\n```  \n\n#### Compatibility\n\nPlugin compiled for java 8, compatible with java 11, 17. \nSupports python 2 (not tested anymore, but should work) and 3 on windows and linux (macos)\n\nGradle | Version\n--------|-------\n7-8     | 4.1.0\n5.3     | [3.0.0](https://xvik.github.io/gradle-use-python-plugin/3.0.0/)\n5-5.2   | [2.3.0](https://xvik.github.io/gradle-use-python-plugin/2.3.0/)\n4.x     | [1.2.0](https://github.com/xvik/gradle-use-python-plugin/tree/1.2.0)\n\n#### Snapshots\n\n\u003cdetails\u003e\n      \u003csummary\u003eSnapshots may be used through JitPack\u003c/summary\u003e\n\n* Go to [JitPack project page](https://jitpack.io/#ru.vyarus/gradle-use-python-plugin)\n* Select `Commits` section and click `Get it` on commit you want to use \n    or use `master-SNAPSHOT` to use the most recent snapshot\n\n* Add to `settings.gradle` (top most!) (exact commit hash might be used as version):\n\n  ```groovy\n  pluginManagement {\n      resolutionStrategy {\n          eachPlugin {\n              if (requested.id.id == 'ru.vyarus.use-python') {\n                  useModule('ru.vyarus:gradle-use-python-plugin:master-SNAPSHOT')\n              }\n          }\n      }\n      repositories {                        \n          gradlePluginPortal()\n          maven { url 'https://jitpack.io' }                    \n      }\n  }    \n  ``` \n* Use plugin without declaring version: \n\n  ```groovy\n  plugins {\n      id 'ru.vyarus.use-python'\n  }\n  ```  \n\n\u003c/details\u003e\n\n#### Python \u0026 Pip\n\nMake sure python and pip are installed:\n\n```bash\npython --version  \npip --version\n```\n\nOn *nix `python` usually reference python2. For python3:\n\n```bash\npython3 --version  \npip3 --version\n```\n\nOR enable docker support to run python inside docker container\n\n### Usage\n\nRead [documentation](https://xvik.github.io/gradle-use-python-plugin/)\n\n### Might also like\n\n* [quality-plugin](https://github.com/xvik/gradle-quality-plugin) - java and groovy source quality checks\n* [animalsniffer-plugin](https://github.com/xvik/gradle-animalsniffer-plugin) - java compatibility checks\n* [pom-plugin](https://github.com/xvik/gradle-pom-plugin) - improves pom generation\n* [java-lib-plugin](https://github.com/xvik/gradle-java-lib-plugin) - avoid boilerplate for java or groovy library project\n* [github-info-plugin](https://github.com/xvik/gradle-github-info-plugin) - pre-configure common plugins with github related info\n\n---\n[![gradle plugin generator](http://img.shields.io/badge/Powered%20by-%20Gradle%20plugin%20generator-green.svg?style=flat-square)](https://github.com/xvik/generator-gradle-plugin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-use-python-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxvik%2Fgradle-use-python-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-use-python-plugin/lists"}