Skip to content

Sync dev with main - update to v0.2.0b1#51

Merged
knowlen merged 11 commits intodevfrom
sync-dev-with-main
Aug 7, 2025
Merged

Sync dev with main - update to v0.2.0b1#51
knowlen merged 11 commits intodevfrom
sync-dev-with-main

Conversation

@knowlen
Copy link
Copy Markdown
Owner

@knowlen knowlen commented Aug 7, 2025

Summary

This PR syncs the dev branch with the latest changes from main, updating dev to version 0.2.0b1.

Changes

  • Updates version from 0.2.0a3 to 0.2.0b1
  • Syncs all documentation updates from main
  • Updates test count from 404 to 428 tests
  • Includes all recent main branch improvements

Purpose

The main branch is currently ahead of dev with the beta release. This PR brings dev up to date with main to ensure both branches are synchronized.

Note

All merge conflicts were resolved by accepting the main branch versions since main contains the more recent v0.2.0b1 release.

knowlen and others added 11 commits August 3, 2025 17:55
* Refactor client.py to reduce file size by 95% (#24)

* Reorganize generated code into _generated subdirectory

* Fix remaining test imports for ValidationError and generated modules

* Suppress websockets deprecation warnings from generated code

* Refactor client.py using factory patterns and mixins

* Fix test failures in refactored client

* Fix remaining test failures and add UNSET export for backward compatibility

* Update documentation to reflect client refactoring

* Fix type annotations and pre-commit issues

* Remove client_save.py backup file

* Fix all mypy type errors for pre-commit compliance

* Fix kwargs passthrough issue in report methods

Remove kwargs passthrough to execute() to prevent HTTP client errors.
Update convenience methods to only pass expected parameters.
Update test to match new behavior where kwargs are not passed through.

* Add dev branch to CI/CD workflow triggers

* Trigger Claude Code Review [review]

* Remove Claude review trigger file

* Allow manual triggering of Claude Code Review workflow

* Fix Claude review workflow to support reopened PRs [review]

Add 'reopened' to PR event types and condition check

* Address high-priority reviewer feedback

- Add Protocol for type safety with model_validate method
- Cache regex patterns for performance improvement
- Improve error messages to show available parameters
- Add comprehensive documentation for method registration
- Fix type annotations to satisfy mypy

* Update documentation for refactored architecture

- Fix markdown formatting in architecture.md for proper rendering
- Update test counts from 278 to 310 tests (105 unit tests)
- Update project structure to reflect new modular architecture
- Add method_factory.py and param_builders.py to unit test docs
- Document new mixins directory structure

* fix formatting

* Bump version to 0.2.0a3

Update version across all project files:
- pyproject.toml
- esologs/__init__.py
- README.md
- CLAUDE.md
- docs/index.md
- docs/changelog.md (with release notes)
- docs/development/architecture.md

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>

* feat: Implement comprehensive guild data API endpoints (5 methods) (#27)

* Implement guild data endpoints

- Add 4 new guild methods: get_guilds(), get_guild(), get_guild_attendance(), get_guild_members()
- Create GraphQL queries for guild search, lookup, attendance, and members
- Add parameter builder for guild attendance with proper defaults
- Implement flexible get_guild() method supporting ID or name/server lookup
- Add comprehensive unit tests (12 new tests)
- Add integration tests (10 new tests)
- Update guild-data.md documentation with examples for all new methods
- Update API coverage from ~83% to ~90% (37/41 methods)

* Fix unit test mocking for httpx.Response objects

* Fix UNSET import in test_character_rankings.py

* Address reviewer comments: fix self type annotation and import location

* Fix guild documentation examples and add comprehensive tests

* Convert relative imports to absolute imports for better maintainability

* Add retry logic and resilience features for integration tests and API clients

* Replace pilcrow (¶) with hash (#) for anchor links in documentation

* Fix pytest configuration for retry logic in integration and docs tests

* Update README files to reflect current project status and guild endpoints

* Fix API coverage metrics: guild endpoints provide ~88% coverage (37/42 methods)

* Address reviewer feedback: fix import consistency and document validation strategy

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>

* Add progress race tracking API endpoint (#28)

* Add progress race tracking API endpoint with 90% coverage

* Fix progress race tests to handle 'No race supported' GraphQL errors

* Update README files to reflect current project status with 90% API coverage

* Add OAuth2 user authentication and UserData API methods (#29)

* Add OAuth2 user authentication and UserData API methods

* Fix type checking and linting issues

* Add missing test dependencies (responses, pytest-xdist)

* Add mkdocs to dev dependencies for complete test coverage

* Fix test dependencies and user auth warnings

- Add mkdocs-material and mkdocs-minify-plugin to dev dependencies
- Fix user authentication warnings in test_user_data.py by using user_token parameter
- Ensure all documentation build dependencies are available for tests

* Consolidate docs dependencies in dev extras

* fix precommit checks

* Implement async OAuth2 support and address PR review concerns

* Remove duplicate API status JavaScript files

* Remove redundant scripts and add token files to gitignore

* Remove redundant optimize_images_simple.py script

* Add README.md documentation for scripts directory

* Add README.md documentation for examples directory

* Update README with output examples and current project state

* Update README: remove NEW tags, normalize output formatting, add missing directories to project structure

* Fix pre-commit checks: remove trailing whitespace and update formatting

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>

* Fix API status checker false positives by using correct favicon URL (#30)

Co-authored-by: knowlen <knowlen@users.noreply.github.com>

* Remove API status checker and improve documentation (#31)

* Remove unreliable API status checker and add troubleshooting guide

* Move troubleshooting to Getting Started section

* Reorganize documentation structure for better navigation

* Fix markdown formatting in authentication guide

* Fix list formatting in authentication guide

* Fix changelog - mark 0.2.0a3 as unreleased and correct dates

* Address PR review comments - add OAuth2 error handling and fix Twitter handle

* fix dates

* Remove non-existent status.esologs.com references and fix future dates

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>

* Prepare v0.2.0b1 beta release

* Add release branch verification workflow

* Update README

* moved to docs

* Fix API method signatures in README to match implementation

* Add return type information to API method documentation

* Replace return type sub-bullets with documentation links

* test formatting

* Update API method documentation to use method names as links

* Refine API docs: only method names are links, parameters are separate code snippets

* Simplify API method list by removing parameters

* clean up

* formatting

* formatting

* formatting

* formatting

* formatting

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>
* Fix test count inconsistencies - update to 428 tests

* Fix Test Pyramid Structure diagram with correct test counts

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>
Co-authored-by: knowlen <knowlen@users.noreply.github.com>
…#46)

* docs: add Enums reference and Advanced Usage guide with filter expressions

* fix: ensure proper list rendering in enums documentation

* fix: correct relative links in enums documentation

* Fix enum documentation links and add enum hyperlinks to parameter tables

- Fixed broken links in enums.md that pointed to report-data instead of report-analysis
- Added hyperlinks to enum types in character-data.md parameter tables
- Added hyperlinks to enum types in report-analysis.md parameter tables
- All enum references in API documentation now link to their definitions

* Fix enum documentation accuracy and improve Advanced Usage formatting

* Add Serena MCP cache files to .gitignore

* Remove Serena cache files from version control

* delete testfiles

* Remove all Serena files from version control and ignore entire .serena directory

* Fix enum documentation to match actual implementation values

* Clarify why some enums aren't exposed - they're used by Zone.characterRankings which isn't a top-level API method

* Add documentation for direct GraphQL access and explain nested field limitations

* Fix incorrect GraphQL field reference: Zone.characterRankings → Encounter.characterRankings

* remove this

* Move Direct GraphQL Access to Getting Started section and remove Advanced Topics

* simplify

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>
authored-by: knowlen <knowlen@users.noreply.github.com>
* Create claude-dispatch.yml

* Fix trailing whitespace in workflow file

---------

Co-authored-by: knowlen <knowlen@users.noreply.github.com>
@claude
Copy link
Copy Markdown

claude bot commented Aug 7, 2025

Claude finished @knowlen's task —— View job


PR Review: Sync dev with main - update to v0.2.0b1

Task Progress:

  • Read and analyze the changed files to understand the PR scope
  • Review new GitHub workflow files for security and best practices
  • Check version updates and dependency changes
  • Assess code quality and best practices
  • Review for potential security concerns
  • Evaluate performance considerations
  • Analyze test coverage changes
  • Compile comprehensive review feedback

📋 Review Summary

This PR successfully syncs the dev branch with main to align with the v0.2.0b1 beta release. The changes are primarily documentation updates, version bumps, and new GitHub workflow additions. Overall, this is a well-structured synchronization PR with good practices.

✅ Positive Findings

Code Quality & Best Practices

  • Clean version management: Version updated consistently across all files (pyproject.toml:7, esologs/__init__.py:1, README.md:22)
  • Comprehensive documentation: Extensive documentation updates with improved structure and new guides
  • Well-organized test structure: 428 tests across multiple suites (unit, integration, docs, sanity)
  • Good tool configuration: Proper linting, formatting, and type checking setup in pyproject.toml:119-209

Security

  • GitHub workflow security: New workflows follow security best practices:
    • claude-dispatch.yml:12-16 uses minimal required permissions
    • release-branch-verification.yml:17-27 implements proper branch naming validation
    • No hardcoded secrets or sensitive information exposed

⚠️ Areas for Improvement

GitHub Workflows

claude-dispatch.yml:39 - Model specification inconsistency:

# Current
model: "claude-opus-4-1-20250805"

Issue: This specifies Claude Opus 4 instead of the default Claude Sonnet 4 mentioned in comments. Consider if this is intentional or should align with the comment on line 37.

claude-dispatch.yml:42-45 - Limited tool permissions:

# allowed_tools: |
  # Bash(npm run lint)
  # Bash(npm run test) 
  # Bash(npm run build)

Suggestion: For a Python project, consider enabling Python-specific tools:

allowed_tools: |
  Bash(pytest)
  Bash(python -m ruff check)
  Bash(python -m mypy esologs)

Documentation

release-branch-verification.yml:24-25 - Error messaging could be more helpful:

echo "Expected format: release/v*.*.*"

Suggestion: Provide examples: "Expected format: release/v1.2.3 or release/v0.2.0b1"

🔍 Technical Assessment

Performance Considerations

  • No performance regressions: Changes are primarily documentation and configuration
  • Test suite expansion: 404 → 428 tests indicates good test coverage growth
  • Dependency stability: No new dependencies added, existing versions maintained

Test Coverage Analysis

  • Comprehensive test structure: Tests organized into logical categories (unit, integration, docs, sanity)
  • Documentation testing: Good practice with tests/docs/ ensuring examples stay current
  • Integration coverage: Multiple integration test files covering core functionality

🎯 Recommendations

  1. Clarify model choice in claude-dispatch.yml:39 - ensure Opus 4 vs Sonnet 4 is intentional
  2. Enable appropriate tools in GitHub workflow for Python development
  3. Consider adding branch cleanup workflow for completed feature branches
  4. Improve error messages in release branch verification for better developer experience

📊 Change Impact Assessment

Category Impact Risk Level
Version Update Low ✅ Low
Documentation Low ✅ Low
GitHub Workflows Medium ⚠️ Medium
Test Coverage Positive ✅ Low
Dependencies None ✅ Low

💡 Overall Assessment

Recommendation: ✅ APPROVE

This is a well-executed branch synchronization with proper version management and comprehensive documentation updates. The minor workflow configuration suggestions are non-blocking improvements that can be addressed in future updates.

The PR successfully achieves its stated goal of syncing dev with main while maintaining code quality and following project conventions.

@knowlen knowlen merged commit 30c2ec0 into dev Aug 7, 2025
9 checks passed
@knowlen knowlen deleted the sync-dev-with-main branch August 7, 2025 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant