Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xvik/gradle-use-python-plugin
Use python modules in gradle build
https://github.com/xvik/gradle-use-python-plugin
docker gradle gradle-plugin python virtualenv
Last synced: about 2 months ago
JSON representation
Use python modules in gradle build
- Host: GitHub
- URL: https://github.com/xvik/gradle-use-python-plugin
- Owner: xvik
- License: mit
- Created: 2017-12-11T04:52:52.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T06:30:04.000Z (4 months ago)
- Last Synced: 2024-05-23T07:29:01.554Z (4 months ago)
- Topics: docker, gradle, gradle-plugin, python, virtualenv
- Language: Groovy
- Homepage: https://xvik.github.io/gradle-use-python-plugin/
- Size: 1.83 MB
- Stars: 67
- Watchers: 4
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gradle use-python plugin
[](http://www.opensource.org/licenses/MIT)
[](https://github.com/xvik/gradle-use-python-plugin/actions/workflows/CI.yml)
[](https://ci.appveyor.com/project/xvik/gradle-use-python-plugin)
[](https://codecov.io/gh/xvik/gradle-use-python-plugin)
**DOCUMENTATION**: https://xvik.github.io/gradle-use-python-plugin/
### About
Plugin **does not install python and pip** itself and use globally installed python (by default).
It's easier to prepare python manually because python have good compatibility (from user perspective) and does not need to
be updated often.
Also, plugin could run python inside docker container to avoid local python installation.
The only plugin intention is to simplify python usage from gradle. By default, plugin creates python virtualenv
inside the project and installs all modules there so each project has its own python (copy) and could not be
affected by other projects or system changes.
Features:
* Works with directly installed python or docker container (with python)
* Creates local (project-specific) virtualenv (project-specific python copy)
* Installs required pip modules (venv by default (with fallback to virtualenv), but could be global installation)
* Support requirements.txt file (limited by default)
* Compatible with gradle configuration cache
* Could be used as basement for building plugins for specific python modules (like
[mkdocs plugin](https://github.com/xvik/gradle-mkdocs-plugin))
**[Who's using (usage examples)](https://github.com/xvik/gradle-use-python-plugin/discussions/18)**
##### Summary
* Configuration: `python`
* Tasks:
- `checkPython` - validate python installation (and create virtualenv if required)
- `cleanPython` - clean created python environment
- `pipInstall` - install declared pip modules
- `pipUpdates` - show the latest available versions for the registered modules
- `pipList` - show all installed modules (the same as pipInstall shows after installation)
- `type:PythonTask` - call python command/script/module
- `type:PipInstallTask` - may be used for custom pip modules installation workflow
### Setup
[](https://maven-badges.herokuapp.com/maven-central/ru.vyarus/gradle-use-python-plugin)
[](https://plugins.gradle.org/plugin/ru.vyarus.use-python)
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'ru.vyarus:gradle-use-python-plugin:4.0.0'
}
}
apply plugin: 'ru.vyarus.use-python'
```
OR
```groovy
plugins {
id 'ru.vyarus.use-python' version '4.0.0'
}
```
#### Compatibility
Plugin compiled for java 8, compatible with java 11, 17.
Supports python 2 (not tested anymore, but should work) and 3 on windows and linux (macos)
Gradle | Version
--------|-------
7.0 | 4.0.0
5.3 | [3.0.0](https://xvik.github.io/gradle-use-python-plugin/3.0.0/)
5-5.2 | [2.3.0](https://xvik.github.io/gradle-use-python-plugin/2.3.0/)
4.x | [1.2.0](https://github.com/xvik/gradle-use-python-plugin/tree/1.2.0)
#### Snapshots
Snapshots may be used through JitPack
* Go to [JitPack project page](https://jitpack.io/#ru.vyarus/gradle-use-python-plugin)
* Select `Commits` section and click `Get it` on commit you want to use
or use `master-SNAPSHOT` to use the most recent snapshot
* Add to `settings.gradle` (top most!) (exact commit hash might be used as version):
```groovy
pluginManagement {
resolutionStrategy {
eachPlugin {
if (requested.id.id == 'ru.vyarus.use-python') {
useModule('ru.vyarus:gradle-use-python-plugin:master-SNAPSHOT')
}
}
}
repositories {
gradlePluginPortal()
maven { url 'https://jitpack.io' }
}
}
```
* Use plugin without declaring version:
```groovy
plugins {
id 'ru.vyarus.use-python'
}
```
#### Python & Pip
Make sure python and pip are installed:
```bash
python --version
pip --version
```
On *nix `python` usually reference python2. For python3:
```bash
python3 --version
pip3 --version
```
OR enable docker support to run python inside docker container
### Usage
Read [documentation](https://xvik.github.io/gradle-use-python-plugin/)
### Might also like
* [quality-plugin](https://github.com/xvik/gradle-quality-plugin) - java and groovy source quality checks
* [animalsniffer-plugin](https://github.com/xvik/gradle-animalsniffer-plugin) - java compatibility checks
* [pom-plugin](https://github.com/xvik/gradle-pom-plugin) - improves pom generation
* [java-lib-plugin](https://github.com/xvik/gradle-java-lib-plugin) - avoid boilerplate for java or groovy library project
* [github-info-plugin](https://github.com/xvik/gradle-github-info-plugin) - pre-configure common plugins with github related info
---
[](https://github.com/xvik/generator-gradle-plugin)