robosystems-client 0.2.23__tar.gz → 0.2.25__tar.gz

robosystems_client-0.2.25/.claude/commands/create-issue.md

@@ -0,0 +1,94 @@
+Create a GitHub issue for the current repository based on the user's input.
+
+## Instructions
+
+1. **Determine Issue Type** - Based on the user's description, determine which type to use:
+   - **Bug**: Defects or unexpected behavior
+   - **Task**: Specific, bounded work items that can be completed in one PR
+   - **Feature**: Request a new capability (no design required)
+   - **RFC**: Propose a design for discussion before implementation (if available)
+   - **Spec**: Approved implementation plan ready for execution (if available)
+
+   Note: Not all repos have RFC/Spec templates. Check `.github/ISSUE_TEMPLATE/` first.
+
+2. **Gather Context** - If the user provides a file path or references existing code:
+   - Read the relevant files to understand the current implementation
+   - Check related configuration files
+   - Review any referenced documentation
+
+3. **Draft the Issue** - Use the YAML templates in `.github/ISSUE_TEMPLATE/`:
+   - `bug.yml` - Include reproduction steps, impact, environment
+   - `task.yml` - Be specific about scope and acceptance criteria
+   - `feature.yml` - Capture the need and why it matters
+   - `spec.yml` - Fill in all sections with technical detail (if available)
+   - `rfc.yml` - Comprehensive design with alternatives considered (if available)
+
+4. **Sanitize for Public Visibility** - Before creating:
+   - Remove any internal pricing, margins, or cost details
+   - Remove specific customer names or data
+   - Generalize any sensitive business metrics
+   - Keep technical implementation details (these are fine to share)
+
+5. **Create the Issue** - Use `gh issue create` with:
+   - Clear, concise title (no prefixes like [SPEC] - types handle categorization)
+   - Well-formatted markdown body matching the template structure
+   - Appropriate metadata labels (see below)
+
+6. **Set Issue Type** - After creation, set the issue type via GraphQL:
+   ```bash
+   # Get repo info from current directory
+   REPO=$(gh repo view --json nameWithOwner -q .nameWithOwner)
+   OWNER=$(echo $REPO | cut -d'/' -f1)
+   NAME=$(echo $REPO | cut -d'/' -f2)
+
+   # Get issue ID
+   gh api graphql -f query="{ repository(owner: \"$OWNER\", name: \"$NAME\") { issue(number: NUMBER) { id } } }"
+
+   # Get available issue types for this repo
+   gh api graphql -f query="{ repository(owner: \"$OWNER\", name: \"$NAME\") { issueTypes(first: 10) { nodes { id name } } } }"
+
+   # Set type (use correct type ID from above)
+   gh api graphql -f query='mutation { updateIssue(input: { id: "ISSUE_ID", issueTypeId: "TYPE_ID" }) { issue { number } } }'
+   ```
+
+## Labels
+
+Issue types handle primary categorization. Use labels for metadata (varies by repo):
+
+**Priority** (when to do it):
+- `priority:critical` - Drop everything
+- `priority:high` - Next up
+- `priority:low` - Backlog
+
+**Size** (how long):
+- `size:small` - < 1 day
+- `size:medium` - 1-3 days
+- `size:large` - > 3 days
+
+**Status**:
+- `blocked` - Waiting on something
+- `needs-review` - Ready for review
+
+Check `gh label list` for available labels in the current repo.
+
+## Example Usage
+
+User: "We need to add export functionality"
+
+Response: I'll create a feature issue for export functionality. Let me first understand the current state...
+
+[Read relevant files to understand current implementation]
+[Draft issue matching the template structure]
+[Create issue with gh issue create]
+[Set issue type via GraphQL]
+[Add appropriate labels]
+
+## Output Format
+
+After creating the issue, provide:
+1. The issue URL
+2. Brief summary of what was created
+3. Issue type and labels applied
+4. Any suggested follow-up tasks or related issues to create
+
+$ARGUMENTS

robosystems_client-0.2.25/.claude/commands/staged-review.md

@@ -0,0 +1,42 @@
+Review all staged changes (`git diff --cached`) with focus on these contexts:
+
+## Client Implementation Context
+
+**API Methods:**
+- Are new methods properly typed with Pydantic models?
+- Is error handling consistent?
+- Are async/sync variants implemented correctly?
+
+**Type Definitions:**
+- Are Pydantic models properly defined?
+- Are types properly exported in `__init__.py`?
+- Is backwards compatibility maintained?
+
+**Code Quality:**
+- Does the code follow existing patterns?
+- Is the code properly formatted (ruff)?
+- Are type hints complete (basedpyright)?
+
+## Testing Context
+
+- Do new methods have corresponding tests?
+- Are edge cases covered?
+- Is test coverage maintained?
+
+## Documentation Context
+
+- Is README updated for new features?
+- Are docstrings complete?
+- Are examples provided for new methods?
+
+## Packaging Context
+
+- Is `pyproject.toml` updated if needed?
+- Are dependencies properly specified?
+
+## Output
+
+Provide a summary with:
+1. **Issues**: Problems that should be fixed before commit
+2. **Suggestions**: Improvements that aren't blocking
+3. **Questions**: Anything unclear that needs clarification

robosystems_client-0.2.25/.claude/commands/test.md

@@ -0,0 +1,20 @@
+Run `just test-all` and systematically fix all failures to achieve 100% completion.
+
+## Strategy
+
+1. **Run full suite first**: `just test-all` to see the full picture
+2. **Fix by module**: When errors exist, use `just test` to iterate faster
+3. **Fix in order**: Linting/formatting → Type errors → Test failures
+4. **Stop when done**: Once `just test-all` passes completely, stop immediately
+
+## Key Commands
+
+- `just test-all` - Full suite (tests + lint + format + typecheck)
+- `just test` - Run pytest
+- `just lint fix` - Auto-fix linting issues
+- `just format` - Auto-fix formatting
+- `just typecheck` - Run basedpyright
+
+## Goal
+
+100% pass rate on `just test-all` with no errors of any kind.

robosystems_client-0.2.25/.github/CONTRIBUTING.md

@@ -0,0 +1,286 @@
+# Contributing to RoboSystems Python Client
+
+Thank you for your interest in contributing to the RoboSystems Python Client! This is the official Python SDK for interacting with the RoboSystems API.
+
+## Community
+
+- **[Discussions](https://github.com/orgs/RoboFinSystems/discussions)** - Questions, ideas, and general conversation
+- **[Project Board](https://github.com/orgs/RoboFinSystems/projects/3)** - Track work across all RoboSystems repositories
+- **[Wiki](https://github.com/RoboFinSystems/robosystems/wiki)** - Architecture docs and guides
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Development Process](#development-process)
+- [How to Contribute](#how-to-contribute)
+- [Development Setup](#development-setup)
+- [Coding Standards](#coding-standards)
+- [Testing](#testing)
+- [Pull Request Process](#pull-request-process)
+- [Publishing](#publishing)
+- [Security](#security)
+
+## Getting Started
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR-USERNAME/robosystems-python-client.git
+   cd robosystems-python-client
+   ```
+3. **Add the upstream remote**:
+   ```bash
+   git remote add upstream https://github.com/RoboFinSystems/robosystems-python-client.git
+   ```
+4. **Set up your development environment** (see [Development Setup](#development-setup))
+
+## Development Process
+
+We use GitHub flow for our development process:
+
+1. Create a feature branch from `main`
+2. Make your changes in small, atomic commits
+3. Write or update tests for your changes
+4. Update documentation as needed
+5. Create a PR to the `main` branch
+
+### Branch Naming
+
+Use descriptive branch names:
+
+- `feature/add-new-method` - New features
+- `bugfix/fix-auth-error` - Bug fixes
+- `chore/update-deps` - Maintenance tasks
+
+**Note:** All PRs must target the `main` branch only.
+
+## How to Contribute
+
+### Issue Types
+
+We use issue templates to organize work:
+
+| Type | When to Use |
+|------|-------------|
+| **Bug** | Defects or unexpected behavior |
+| **Task** | Specific, bounded work that fits in one PR |
+| **Feature** | Request a new capability (no design required) |
+| **RFC** | Propose a design for discussion before implementation |
+| **Spec** | Approved implementation plan ready for execution |
+
+### Reporting Bugs
+
+Before creating a bug report, check existing issues to avoid duplicates. Include:
+
+- Steps to reproduce the issue
+- Expected vs actual behavior
+- SDK version (`pip show robosystems-client`)
+- Python version
+- Relevant error messages and tracebacks
+
+### First-Time Contributors
+
+Look for issues labeled `good first issue` or `help wanted`. These are great starting points for new contributors.
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.11+ (check `.python-version`)
+- `uv` for package management
+- Git configured with your GitHub account
+
+### Local Development Environment
+
+1. **Install uv** (if not already installed):
+
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   # Or on macOS: brew install uv
+   ```
+
+2. **Install dependencies**:
+
+   ```bash
+   uv sync
+   ```
+
+3. **Run tests**:
+
+   ```bash
+   uv run pytest
+   ```
+
+### Environment Configuration
+
+For integration tests, create a `.env` file:
+
+```env
+ROBOSYSTEMS_API_KEY=your-api-key
+ROBOSYSTEMS_API_URL=https://api.robosystems.ai  # or http://localhost:8000 for local
+```
+
+## Coding Standards
+
+### Python Code Style
+
+- **Formatter**: Ruff (88 character line length)
+- **Linter**: Ruff
+- **Type checking**: Pyright/Basedpyright
+- **Docstrings**: Google style
+
+Run code quality checks:
+
+```bash
+uv run ruff check .      # Run linting
+uv run ruff check --fix  # Auto-fix linting issues
+uv run ruff format .     # Format code
+uv run pyright           # Type checking
+```
+
+### Commit Messages
+
+Follow the Conventional Commits specification:
+
+```
+type(scope): subject
+```
+
+Types:
+
+- `feat`: New feature (new method, type, etc.)
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `refactor`: Code refactoring
+- `test`: Test changes
+- `chore`: Maintenance tasks
+
+Examples:
+
+```
+feat(graphs): add create_graph method
+fix(auth): resolve token refresh issue
+docs(readme): update usage examples
+```
+
+### SDK Design Guidelines
+
+When adding new methods:
+
+- Follow existing naming conventions (snake_case)
+- Use Pydantic models for request/response types
+- Include comprehensive docstrings with examples
+- Add type hints to all functions
+- Handle errors with appropriate exception types
+
+## Testing
+
+### Test Requirements
+
+- All new methods must include tests
+- Bug fixes should include regression tests
+- Tests must pass locally before submitting PR
+
+### Running Tests
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run with coverage
+uv run pytest --cov
+
+# Run specific test file
+uv run pytest tests/test_graphs.py
+
+# Run with verbose output
+uv run pytest -v
+```
+
+## Pull Request Process
+
+### Before Creating a PR
+
+1. **Commit all changes**:
+
+   ```bash
+   git add .
+   git commit -m "feat: your descriptive commit message"
+   ```
+
+2. **Update from upstream**:
+
+   ```bash
+   git fetch origin
+   git rebase origin/main
+   ```
+
+3. **Run all checks locally**:
+
+   ```bash
+   uv run ruff check .
+   uv run ruff format --check .
+   uv run pytest
+   ```
+
+4. **Push your branch**:
+   ```bash
+   git push origin your-branch-name
+   ```
+
+### PR Requirements
+
+- All tests must pass
+- Code must pass linting and formatting checks
+- Must include appropriate documentation updates
+- Must be reviewed by at least one maintainer
+
+### Manual PR Creation
+
+```bash
+gh pr create --base main --title "Your PR title" --body "Your PR description"
+```
+
+## Publishing
+
+This package is published to PyPI as `robosystems-client`. Releases are managed by maintainers:
+
+```bash
+# Build the package
+uv build
+
+# Publish to PyPI
+uv publish
+```
+
+**Note:** Only maintainers can publish new versions.
+
+## Security
+
+### Security Vulnerabilities
+
+**DO NOT** create public issues for security vulnerabilities. Instead:
+
+1. Email security@robosystems.ai with details
+2. Include steps to reproduce if possible
+3. Allow time for the issue to be addressed before public disclosure
+
+### Security Best Practices
+
+- Never commit API keys or secrets
+- Never log sensitive data
+- Validate inputs before sending to API
+- Keep dependencies up to date
+
+## Questions and Support
+
+- **[GitHub Discussions](https://github.com/orgs/RoboFinSystems/discussions)** - Best place for questions and community conversation
+- **[GitHub Issues](https://github.com/RoboFinSystems/robosystems-python-client/issues)** - Bug reports and feature requests for this repo
+- **[API Reference](https://api.robosystems.ai/docs)** - Backend API documentation
+- **Email**: security@robosystems.ai for security issues only
+
+## Recognition
+
+Contributors will be recognized in our [Contributors](https://github.com/RoboFinSystems/robosystems-python-client/graphs/contributors) page.
+
+Thank you for contributing to RoboSystems Python Client!

robosystems_client-0.2.25/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,81 @@
+name: Bug
+description: Something isn't working
+type: Bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug! Please fill out the details below.
+
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: What's broken?
+      placeholder: Describe the issue...
+    validations:
+      required: true
+
+  - type: dropdown
+    id: impact
+    attributes:
+      label: Impact
+      options:
+        - Critical
+        - High
+        - Medium
+        - Low
+    validations:
+      required: true
+
+  - type: textarea
+    id: version
+    attributes:
+      label: Version
+      description: What version are you using?
+      placeholder: |
+        robosystems-client version: x.x.x
+        Python version: x.x.x
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this?
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      placeholder: What should happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      placeholder: What actually happens?
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Error Messages / Logs
+      render: shell
+      placeholder: Paste any relevant error messages or stack traces here
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      placeholder: Client configuration, environment, workarounds tried...

robosystems_client-0.2.25/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussion
+    url: https://github.com/orgs/RoboFinSystems/discussions
+    about: For questions or general discussion, start a GitHub Discussion instead

robosystems_client-0.2.25/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,34 @@
+name: Feature
+description: Request a new capability (no design required)
+type: Feature
+body:
+  - type: textarea
+    id: request
+    attributes:
+      label: What would you like?
+      description: A clear description of what you wish you could do.
+      placeholder: I wish I could...
+    validations:
+      required: true
+
+  - type: textarea
+    id: why
+    attributes:
+      label: Why?
+      description: What problem would this solve for you?
+      placeholder: This would help because...
+    validations:
+      required: true
+
+  - type: textarea
+    id: ideas
+    attributes:
+      label: Any ideas on how?
+      description: Optional - if you have thoughts on implementation, share them here.
+      placeholder: One way to do this might be...
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      placeholder: Examples, links, or references that help explain the request.

robosystems_client-0.2.25/.github/ISSUE_TEMPLATE/rfc.yml

@@ -0,0 +1,103 @@
+name: RFC
+description: Propose a design for discussion before implementation
+type: RFC
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: One paragraph explaining the proposal
+      placeholder: This RFC proposes...
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: "Motivation: Problem"
+      description: What problem does this solve?
+      placeholder: Currently, we have...
+    validations:
+      required: true
+
+  - type: textarea
+    id: why-now
+    attributes:
+      label: "Motivation: Why Now?"
+      description: Why is this the right time?
+      placeholder: This is urgent because...
+
+  - type: textarea
+    id: overview
+    attributes:
+      label: "Proposed Design: Overview"
+      description: High-level approach
+      placeholder: The proposed solution is to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: detailed-design
+    attributes:
+      label: "Proposed Design: Detailed Design"
+      description: Technical details, architecture, API design
+      placeholder: |
+        ## Architecture
+
+        ## API Design
+
+        ## MCP Protocol Considerations
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      placeholder: |
+        | Alternative | Pros | Cons |
+        |-------------|------|------|
+        | Option A | | |
+        | Option B | | |
+
+        **Why this approach:**
+
+  - type: textarea
+    id: phases
+    attributes:
+      label: "Implementation: Phases"
+      placeholder: |
+        1. **Phase 1:**
+        2. **Phase 2:**
+
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: "Implementation: Dependencies"
+      placeholder: List any dependencies or blockers
+
+  - type: textarea
+    id: risks
+    attributes:
+      label: Risks & Mitigations
+      placeholder: |
+        | Risk | Mitigation |
+        |------|------------|
+        | | |
+
+  - type: textarea
+    id: questions
+    attributes:
+      label: Open Questions
+      description: Questions for discussion
+      placeholder: |
+        - [ ]
+        - [ ]
+
+  - type: textarea
+    id: references
+    attributes:
+      label: References
+      placeholder: |
+        - Related: #
+        - External: