chore: add readme updates for python (#18)

Arize-ai · Jan 2, 2024 · 0660f67 · 0660f67
1 parent bdd13de
commit 0660f67
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,12 @@ The OpenInference specification is edited in markdown files found in the [spec d
 
 OpenInference provides a set of instrumentations for popular machine learning SDKs and frameworks in a variety of languages.
 
+## Python
+
+| Package                                                                                       | Description                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------- |
+| [`openinference-semantic-conventions`](./python/openinference-semantic-conventions/README.md) | Semantic conventions for tracing of LLM Apps. |
+
 ## JavaScript
 
 | Package                                                                                                         | Description                                   |

diff --git a/python/README.md b/python/README.md
@@ -0,0 +1,16 @@
+# OpenInference Python
+
+This is the Python version of OpenInference, a framework for collecting traces from LLM applications.
+
+## Development
+
+This project is built using hatch.
+
+## Publishing
+
+Publishing to PyPi is done using hatch.
+
+```shell
+hatch build
+hatch publish -u __token__
+```
diff --git a/python/openinference-semantic-conventions/README.md b/python/openinference-semantic-conventions/README.md
@@ -1,3 +1,5 @@
 # OpenInference Semantic Conventions
 
+[![pypi](https://badge.fury.io/py/openinference-semantic-conventions.svg)](https://pypi.org/project/openinference-semantic-conventions/)
+
 This library contains code for the OpenInference Semantic Conventions defined by the OpenInference specification.