Skip to main content

Python library and cli to communicate with DPUs and IPUs

Project description

pydpu

License Pulls PyPI Code style: black codecov Linters Docker Tests

Python library and cli to communicate with DPUs and IPUs

I Want To Contribute

This project welcomes contributions and suggestions. We are happy to have the Community involved via submission of Issues and Pull Requests (with substantive content or even just fixes). We are hoping for the documents, test framework, etc. to become a community process with active engagement. PRs can be reviewed by by any number of people, and a maintainer may accept.

See CONTRIBUTING and GitHub Basic Process for more details.

Installation

There are several ways of running this CLI.

Docker

docker pull opiproject/pydpu:<version>

You can specify a version like 0.1.1 or use latest to get the most up-to-date version.

Run latest version of the CLI in a container:

docker run --rm opiproject/pydpu:latest --help

Replace --help with any pydpu command, without pydpu itself.

PyPI

pip install pydpu

Usage

Inventory

To get inventory, run:

pydpu --address=localhost:50151 inventory get

Ipsec

To create a tunnel, run:

pydpu --address=localhost:50151 ipsec create-tunnel

To get statistics, run:

pydpu --address=localhost:50151 ipsec stats

Packaging

This project uses poetry to manage dependencies, build, etc.

Releasing new versions

# Make sure you have dev dependencies installed
$ poetry install --group dev
# Use bump2version to update version strings and create a new tag
$ bump2version <patch|minor|major>
# Push new tag
$ git push --tags
# Create GitHub release
$ gh release create v$(poetry version -s) --generate-notes

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydpu-0.1.2.tar.gz (45.9 kB view hashes)

Uploaded Source

Built Distribution

pydpu-0.1.2-py3-none-any.whl (60.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page