From f50019b72dbcc181f4060ab897a66b7f3d963dfa Mon Sep 17 00:00:00 2001
From: Mikyo King <mikyo@arize.com>
Date: Tue, 2 Jan 2024 13:32:21 -0700
Subject: [PATCH] chore: add readme updates for python

---
 README.md                                        |  6 ++++++
 python/README.md                                 | 16 ++++++++++++++++
 .../openinference-semantic-conventions/README.md |  2 ++
 3 files changed, 24 insertions(+)
 create mode 100644 python/README.md

diff --git a/README.md b/README.md
index f533eeff2..e7184f3a2 100644
--- 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
new file mode 100644
index 000000000..924d144c0
--- /dev/null
+++ 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
index 9bad6cc7a..a4eedcda9 100644
--- 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.