polos-sdk 0.1.0__tar.gz

polos_sdk-0.1.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Ignore all node_modules folders everywhere
+node_modules/
+
+.DS_Store

polos_sdk-0.1.0/BUILD.md

@@ -0,0 +1,305 @@
+# Building and Releasing Polos Python SDK
+
+This document describes how to build, test, and release the `polos-sdk` Python package.
+
+## Prerequisites
+
+- Python 3.10+ installed
+- [UV](https://github.com/astral-sh/uv) (recommended) or `pip` and `build`
+- Git access to the repository
+- PyPI account (for publishing releases)
+
+## Local Development
+
+### Setup
+
+```bash
+cd sdk/python
+
+# Using UV (recommended)
+uv sync --dev
+
+# Or using pip
+python -m venv venv
+source venv/bin/activate  # Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Using UV
+uv run pytest
+
+# Or using pip
+pytest
+
+# With coverage
+uv run pytest --cov=polos --cov-report=html
+```
+
+### Code Quality
+
+```bash
+# Format code
+uv run ruff format .
+
+# Lint code
+uv run ruff check .
+
+# Auto-fix linting issues
+uv run ruff check --fix .
+```
+
+## Building the Package
+
+### Build Locally
+
+```bash
+cd sdk/python
+
+# Install build tools
+pip install build hatchling hatch-vcs
+
+# Build package (creates sdist and wheel in dist/)
+python -m build
+```
+
+This will create:
+- `dist/polos-sdk-<version>.tar.gz` (source distribution)
+- `dist/polos-sdk-<version>-py3-none-any.whl` (wheel distribution)
+
+### Verify the Build
+
+```bash
+# Check package metadata
+python -m pip install --upgrade pip
+pip install twine
+twine check dist/*
+```
+
+### Test Installation
+
+```bash
+# Install from local build
+pip install dist/polos-sdk-*.whl
+
+# Or install from source
+pip install dist/polos-sdk-*.tar.gz
+
+# Verify installation
+python -c "import polos; print(polos.__version__)"
+```
+
+## Version Management
+
+The package uses [hatch-vcs](https://github.com/ofek/hatch-vcs) for automatic version management from Git tags.
+
+- Version is automatically derived from Git tags matching `python-sdk-v*`
+- Tag format: `python-sdk-v<version>` (e.g., `python-sdk-v0.1.0`)
+- The version in `pyproject.toml` is set to `dynamic = ["version"]`
+- During build, `hatch-vcs` extracts the version from the Git tag
+
+### Manual Version Check
+
+To see what version would be built from the current Git state:
+
+```bash
+cd sdk/python
+python -c "from hatchling.build import build_sdist; import os; os.chdir('.'); print(build_sdist('dist'))"
+```
+
+Or check the Git tags:
+
+```bash
+git tag -l "python-sdk-v*"
+```
+
+## Releasing to PyPI
+
+### Release Process
+
+The release process is automated via GitHub Actions. To create a release:
+
+#### 1. Ensure Code is Ready
+
+```bash
+# Make sure all changes are committed
+git status
+
+# Run tests locally
+cd sdk/python
+uv run pytest
+
+# Check code quality
+uv run ruff format .
+uv run ruff check .
+```
+
+#### 2. Commit and Push Changes
+
+```bash
+git add .
+git commit -m "Prepare for release v0.1.0"
+git push origin main  # or your branch name
+```
+
+#### 3. Create and Push Release Tag
+
+```bash
+# Create the tag (must match pattern: python-sdk-v*)
+git tag python-sdk-v0.1.0
+
+# Push the tag to trigger the release workflow
+git push origin python-sdk-v0.1.0
+
+# Or push all tags
+git push origin --tags
+```
+
+#### 4. Monitor the Release
+
+1. Go to your GitHub repository
+2. Click the "Actions" tab
+3. Find the "Release Python SDK" workflow run
+4. The workflow will:
+   - ✅ Run tests on Python 3.10, 3.11, 3.12
+   - ✅ Build the package (sdist + wheel)
+   - ✅ Validate the package with `twine check`
+   - ✅ Create a GitHub Release with artifacts
+   - ✅ Publish to PyPI
+
+#### 5. Verify the Release
+
+After the workflow completes:
+
+**GitHub Release:**
+- Visit: `https://github.com/polos-dev/polos/releases`
+- You should see the new release with download links
+
+**PyPI:**
+- Visit: `https://pypi.org/project/polos-sdk/`
+- The new version should be listed
+
+**Installation Test:**
+```bash
+pip install polos-sdk
+python -c "import polos; print(polos.__version__)"
+```
+
+### Manual Release (Alternative)
+
+If you need to release manually without GitHub Actions:
+
+```bash
+cd sdk/python
+
+# 1. Ensure you're on the correct tag
+git checkout python-sdk-v0.1.0
+
+# 2. Build the package
+python -m build
+
+# 3. Verify the build
+twine check dist/*
+
+# 4. Upload to PyPI
+twine upload dist/* \
+  --username __token__ \
+  --password <your-pypi-api-token>
+```
+
+## Release Notes
+
+The GitHub Actions workflow automatically generates release notes from commits between tags:
+
+- For the first release: All commits up to the tag
+- For subsequent releases: Commits since the last `python-sdk-v*` tag
+
+You can edit the release notes in the GitHub Release after it's created.
+
+## Troubleshooting
+
+### Build Fails: "No tags found"
+
+**Problem**: `hatch-vcs` can't find a matching Git tag.
+
+**Solution**: 
+- Ensure you're in a Git repository
+- Check that tags exist: `git tag -l "python-sdk-v*"`
+- Make sure you've fetched tags: `git fetch --tags`
+- For local builds, you may need to be on a tagged commit
+
+### Version Extraction Fails
+
+**Problem**: Version can't be extracted from tag.
+
+**Solution**:
+- Ensure tag format is exactly `python-sdk-v<version>` (e.g., `python-sdk-v0.1.0`)
+- Check `pyproject.toml` has `tag-pattern = "python-sdk-v(?P<version>.*)"` in `[tool.hatch.version]`
+
+### PyPI Upload Fails: 401 Unauthorized
+
+**Problem**: Authentication failed.
+
+**Solution**:
+- Verify `PYPI_API_TOKEN` is set in GitHub Secrets
+- Check the token hasn't expired or been revoked
+- Ensure the token has the correct scope (entire account or project-specific)
+
+### Tests Fail in CI
+
+**Problem**: Tests pass locally but fail in GitHub Actions.
+
+**Solution**:
+- Check the test output in the Actions tab
+- Ensure all dependencies are listed in `pyproject.toml`
+- Verify Python version compatibility
+- Check for environment-specific issues
+
+## Package Structure
+
+```
+sdk/python/
+├── polos/              # Main package
+│   ├── __init__.py     # Package initialization (includes __version__)
+│   ├── agents/         # Agent implementation
+│   ├── core/           # Core workflow/step/context
+│   ├── features/       # Events, schedules, tracing
+│   ├── llm/            # LLM providers
+│   ├── middleware/     # Hooks and guardrails
+│   ├── runtime/        # Worker and client
+│   ├── tools/          # Tool implementation
+│   ├── types/          # Type definitions
+│   └── utils/          # Utility functions
+├── tests/              # Test suite
+├── pyproject.toml      # Package configuration
+├── README.md           # Package documentation
+└── BUILD.md            # This file
+```
+
+## Version Numbering
+
+Follow [Semantic Versioning](https://semver.org/):
+- **MAJOR**: Breaking changes
+- **MINOR**: New features (backward compatible)
+- **PATCH**: Bug fixes (backward compatible)
+
+Examples:
+- `python-sdk-v0.1.0` - Initial release
+- `python-sdk-v0.1.1` - Patch release (bug fixes)
+- `python-sdk-v0.2.0` - Minor release (new features)
+- `python-sdk-v1.0.0` - Major release (breaking changes)
+
+## Related Documentation
+
+- [Package README](./README.md) - User-facing documentation
+- [GitHub Actions Workflow](../.github/workflows/release-python-sdk.yml) - Automated release workflow
+- [PyPI Project](https://pypi.org/project/polos-sdk/) - Published package page
+
+## Support
+
+For issues or questions:
+- 📖 [Documentation](https://docs.polos.dev)
+- 💬 [Discord Community](https://discord.gg/polos)
+- 🐛 [Issue Tracker](https://github.com/polos-dev/polos/issues)