Skip to content

Commit

Permalink
chore: Add workflow badges
Browse files Browse the repository at this point in the history
  • Loading branch information
AllexVeldman authored Aug 2, 2024
1 parent ef8b05e commit fd590db
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# PyOCI
Publish and download python packages using OCI registries
Publish and download python packages using OCI registries.

[![Test](https://github.com/AllexVeldman/pyoci/actions/workflows/test.yaml/badge.svg)](https://github.com/AllexVeldman/pyoci/actions/workflows/test.yaml)
[![Examples](https://github.com/AllexVeldman/pyoci/actions/workflows/examples.yaml/badge.svg)](https://github.com/AllexVeldman/pyoci/actions/workflows/examples.yaml)
[![Deploy](https://github.com/AllexVeldman/pyoci/actions/workflows/deploy.yaml/badge.svg)](https://github.com/AllexVeldman/pyoci/actions/workflows/deploy.yaml)

PyOCI allows using any (private) OCI registry as a python package index.
It acts as a proxy between pip and the OCI registry.
Expand All @@ -18,9 +22,9 @@ instead the [token authentication](https://distribution.github.io/distribution/s

To install a package with pip using PyOCI:
```commandline
pip install --extra-index-url=http://<username>:<password>@<pyoci url>/<OCI registry url>/<namespace>/ <package name>
pip install --extra-index-url=http://<username>:<password>@<pyoci url>/<OCI registry url>/<namespace>/<package name>
```
Example installing package `bar` from user `Foo` using `ghcr.io` as the registry:
```commandline
pip install --extra-index-url=https://Foo:[email protected]/ghcr.io/foo/ bar
pip install --extra-index-url=https://Foo:[email protected]/ghcr.io/foo/bar
```

0 comments on commit fd590db

Please sign in to comment.