Project import generated by Copybara.

GitOrigin-RevId: 17938477f5f6ba11167a14564ad918ba6e7b7716

Author: Lightspark Eng

README.md

@@ -2,6 +2,14 @@
 
 The Lightspark Python SDK provides a convenient way to interact with the Lightspark services from applications written in the Python language.
 
+## Installation
+
+To install the SDK, simply run:
+
+```bash
+pip install lightspark
+```
+
 ## Documentation
 
 The documentation for this SDK (installation, usage, etc.) is available at https://app.lightspark.com/docs/sdk

RELEASE.md

@@ -0,0 +1,25 @@
+# Releasing the Python SDK
+
+## Step 1: Update version number
+
+You'll need to update the version number in the format `X.Y.Z`.
+
+We are following the SEMVER spec, so:
+
+- increase `X` for breaking changes
+- increase `Y` for non-breaking changes that add functionality
+- increase `Z` for non-breaking bug fixes
+
+You'll need to bump the version number in `<WEBDEV_ROOT>/python-sdk/lightspark/version.py`.
+
+## Step 2: Changelog
+
+Edit the file `<WEBDEV_ROOT>/sdk/CHANGELOG.md` and add all the relevant changes since the last version.
+
+## Step 3: Tag and publish the release
+
+After merging these changes to main, open the repo in github and publish a new release from the main branch
+with the version number you chose in step 1 (tagged `vX.Y.Z`). The release notes should be the same as the
+changelog you wrote in step 2.
+
+Publishing the release will automatically trigger a CI job to publish the new version to PyPI.

copy.bara.sky

@@ -46,7 +46,7 @@ core.workflow(
 
     origin_files = glob(
 	    ["python-sdk/**", "copy.bara.sky"],
-        exclude = ["python-sdk/examples/internal_example.py"],
+        exclude = ["python-sdk/examples/internal_example.py", "python-sdk/RELEASE-internal.md"],
     ),
 
     authoring = authoring.pass_thru("Lightspark Eng <engineering@lightspark.com>"),