Join 10350+ others. No spamming.
I promise!

Follow us at github.



linkedin/pygradle

228

linkedin / pygradle

Groovy

Using Gradle to build Python projects


READ ME

PyGradle

CircleCI AppVeyor Bintray Linkedin license

PyGradle is an enterprise Python build system.

PyGradle leverages Gradle to empower Python's existing ecosystem to solve problems like dependency management, polyglot projects, and lots more. LinkedIn has been using PyGradle for several years to successfully manage thousands of Python dependencies.

PyGradle produces artifacts, e.g., source distributions, that are forward and backward compatible with artifacts produced by vanilla setuptools, so there is nothing stopping you from using PyGradle with one, two, or all of your Python projects right away!

As a general philosophy, we strive to enhance Python rather than replace it, thereby keeping open source Python development idiomatic and intuitive.

Usage

PyGradle does not include batteries: there are a few things that you're going to have to do to use PyGradle for things beyond our provided examples.

In particular, you're going to have to:

  • Decide how you want to host your artifacts.
  • Decide how you want to distribute a custom setuptools distribution class.
  • Author your build.gradle file.

These decisions and tasks shouldn't take to long for you finish, but they are required. A deeper dive into what it takes to get started, how you can use our demonstrative Artifactory instance, and a few project examples is available in our detailed getting started guide.

Although not required, if you've never used Gradle before, you might find reading Gradle's user guide helpful.

Plugins

PyGradle comes with several plugins available, for specific details on each plugin check the documentation specific to that plugin.

Plugin Usage
com.linkedin.python Extending PyGradle
com.linkedin.python-sdist Developing Source Distributions
com.linkedin.python-web-app Developing Flask/Gunicorn Web Applications
com.linkedin.python-cli Developing Command Line Applications
com.linkedin.python-flyer Developing Flyer (Flask + Ember) Applications
com.linkedin.python-pex Developing Pex Applications

Developers

We're actively maintaining PyGradle and accepting pull requests.

If you're interested in contributing code to PyGradle, please see our developers document to get started. This document covers how to build, test, and debug PyGradle, and kindly asks that you follow a few conventions when submitting pull requests.

Compatibility

Software

We support PyGradle on the following software versions.

Software Version
Java 7.0
Gradle 3.0

We're happy to review and merge pull requests that add additional support to future versions of software.

Platforms

PyGradle works on the following platforms.

Platform Support
Linux Full
OS X Full
Windows Partial

Additional compatibility notes are availabe here. We're happy to review and merge pull requests that add support for additional platforms.