python-pachyderm 2.0.0

Python Pachyderm Client

Python Pachyderm

Official Python Pachyderm client. Created by kalugny (formerly kalugny/pypachy), and now maintained by Pachyderm Inc.

This library provides the autogenerated gRPC/protobuf code for Pachyderm, along with a higher-level and more pythonic Client class. See the API docs.

Installation

pip install python-pachyderm

A Small Taste

Here's an example that creates a repo and adds a file:

import python_pachyderm
client = python_pachyderm.PfsClient()
client.create_repo('test')
with client.commit('test', 'master') as c:
    client.put_file_bytes(c, '/dir_a/data.txt', b'DATA')

For more sophisticated examples, see the examples directory.

Versioning

Prior to python-pachyderm 2.0, this library's versioning synced with pachyderm's core versioning; e.g. version 1.8.5 of this library synced with 1.8.5 of pachyderm core. python-pachyderm 2.0 onwards uses semver instead, so versions are not tied to pachyderm core. This was done for two reasons:

1. Sometimes this library makes breaking or backwards-incompatible changes, which aren't properly conveyed by revision changes.
2. Pachyderm core has stabilized enough that, even if you're using an older version of this library, it will usually work with newer versions of a pachyderm cluster.

However, do note that each version of python-pachyderm is only tested against one version of pachyderm core, and there are ways in which this library may be incompatible with certain versions of pachyderm core. If you are seeing an issue and want to rule out that possibility, consult CHANGELOG.md to see what version of pachyderm core was used to build any given version of python-pachyderm. Alternatively, you can consult version.json to see what version of pachyderm core is currently being tested against.

As a broad rule of thumb, we recommend working with the latest version of both pachyderm core and python-pachyderm where possible.

Contributing

This driver is co-maintained by Pachyderm and the community. If you're looking to contribute to the project, this is a fantastic place to get involved.

Getting started

To run tests, clone the repo, install jq, then run:

make init
tox