Dev

[fasteiner]

No description provided.

[fasteiner]

@copilot please fix by implementing lazy loading (like shown in various examples in the code on co dependant classes):

Run # Stop the build on syntax errors or undefined names
./src/xurrent/core.py:48:15: F821 undefined name 'Person'
api_user: Person # Forward declaration with a string
^
./src/xurrent/core.py:49:26: F821 undefined name 'Team'
api_user_teams: List[Team] # Forward declaration with a string
^
./src/xurrent/people.py:83:33: F821 undefined name 'Team'
def get_teams(self) -> List[Team]:
^
./src/xurrent/requests.py:80:24: F821 undefined name 'Workflow'
workflow: Optional[Workflow]
^
./src/xurrent/requests.py:105:37: F821 undefined name 'Workflow'
workflow: Optional[Workflow] = None,
^
./src/xurrent/requests.py:339:98: F821 undefined name 'ConfigurationItem'
def get_cis_by_request_id(cls, connection_object: XurrentApiHelper, request_id: int) -> List[ConfigurationItem]:
^
./src/xurrent/requests.py:386:31: F821 undefined name 'ConfigurationItem'
def get_cis(self) -> List[ConfigurationItem]:
^
./src/xurrent/tasks.py:76:26: F821 undefined name 'self'
uri += '?' + self._connection_object.create_filter_string(queryfilter)
^
./src/xurrent/tasks.py:87:12: F821 undefined name 'task'
if task.workflow and not expand:
^
./src/xurrent/tasks.py:89:14: F821 undefined name 'task'
elif task.workflow and expand:
^
./src/xurrent/tasks.py:91:18: F821 undefined name 'task'
elif not task.workflow:
^
./src/xurrent/workflows.py:111:128: F821 undefined name 'Task'
def get_workflow_tasks_by_workflow_id(cls, connection_object: XurrentApiHelper, id: int, queryfilter: dict = None) -> List[Task]:
^
./src/xurrent/workflows.py:118:59: F821 undefined name 'Task'
def get_tasks(self, queryfilter: dict = None) -> List[Task]:
^
./src/xurrent/workflows.py:130:126: F821 undefined name 'Task'
def get_workflow_task_by_template_id(cls, connection_object: XurrentApiHelper, workflowID: int, templateID: int) -> List[Task]:
^
./src/xurrent/workflows.py:137:64: F821 undefined name 'Task'
def get_task_by_template_id(self, templateID: int) -> List[Task]:
^
15 F821 undefined name 'Person'

[Copilot]

Pull request overview

This PR significantly expands the Xurrent Python client by adding many new resource/domain modules (and sub-resource helper methods), alongside a broad set of unit tests and CI/release pipeline updates to support the expanded surface area.

Changes:

• Added many new domain classes (e.g., Projects, Releases, Risks, ServiceInstances, Shop* resources, etc.) plus additional sub-resource convenience methods across existing models.
• Added extensive unit test coverage for the new domain modules and sub-resource methods.
• Updated packaging/metadata, documentation, changelog, and GitHub Actions workflows (tests + release automation).

Reviewed changes

Copilot reviewed 61 out of 62 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/unit_tests/test_skill_pools.py	Adds unit tests for SkillPool CRUD and sub-resources.
tests/unit_tests/test_sites.py	Adds unit tests for Site CRUD and lifecycle methods.
tests/unit_tests/test_shop.py	Adds unit tests for shop article/category/order-line resources and enums.
tests/unit_tests/test_service_offerings.py	Adds unit tests for ServiceOffering CRUD/filtering.
tests/unit_tests/test_service_instances.py	Adds unit tests for ServiceInstance CRUD and sub-resources.
tests/unit_tests/test_risks.py	Adds unit tests for Risk CRUD/lifecycle and sub-resources.
tests/unit_tests/test_releases.py	Adds unit tests for Release CRUD/lifecycle and notes.
tests/unit_tests/test_referenced_types.py	Adds tests covering multiple referenced-type deserializations.
tests/unit_tests/test_projects.py	Adds unit tests for Project CRUD/lifecycle and sub-resources.
tests/unit_tests/test_products.py	Adds unit tests for Product CRUD/lifecycle and CI listing.
tests/unit_tests/test_problems.py	Adds unit tests for Problem CRUD/lifecycle and sub-resources.
tests/unit_tests/test_out_of_office_periods.py	Adds unit tests for OutOfOfficePeriod CRUD/DELETE.
tests/unit_tests/test_organizations.py	Adds unit tests for Organization CRUD/lifecycle and sub-resources.
tests/unit_tests/test_knowledge_articles.py	Adds unit tests for KnowledgeArticle CRUD/lifecycle and sub-resources.
tests/unit_tests/test_holidays.py	Adds unit tests for Holiday CRUD and filtering.
tests/unit_tests/test_custom_collections.py	Adds unit tests for custom collections/elements and listing.
tests/unit_tests/test_contracts.py	Adds unit tests for Contract CRUD/filtering and CI listing.
tests/unit_tests/test_closure_codes.py	Adds unit tests for ClosureCode CRUD.
src/xurrent/workflows.py	Adds workflow sub-resource helpers (notes, automation rules, phases, related items).
src/xurrent/workflow_templates.py	Introduces WorkflowTemplate resource model and filters/enums.
src/xurrent/ui_extensions.py	Introduces UiExtension resource model and category enum.
src/xurrent/time_allocations.py	Introduces TimeAllocation resource model and category enums.
src/xurrent/teams.py	Adds Team.get_service_instances().
src/xurrent/tasks.py	Adds task sub-resource helpers (notes, approvals, CIs, links, automation rules).
src/xurrent/skill_pools.py	Introduces SkillPool resource model and sub-resources.
src/xurrent/sites.py	Introduces Site resource model including lifecycle methods.
src/xurrent/shop_order_lines.py	Introduces ShopOrderLine resource model and enums.
src/xurrent/shop_articles.py	Introduces ShopArticle resource model and enums.
src/xurrent/shop_article_categories.py	Introduces ShopArticleCategory resource model and filters.
src/xurrent/services.py	Introduces/extends Service resource model with multiple sub-resource methods.
src/xurrent/service_offerings.py	Introduces ServiceOffering resource model and enums.
src/xurrent/service_instances.py	Introduces ServiceInstance resource model and enums/sub-resources.
src/xurrent/risks.py	Introduces Risk resource model and enums/sub-resources.
src/xurrent/requests.py	Adds several request sub-resource helper methods (attachments, tags, watches, etc.).
src/xurrent/request_templates.py	Introduces RequestTemplate resource model and enums.
src/xurrent/releases.py	Introduces Release resource model and enums/sub-resources.
src/xurrent/projects.py	Introduces Project resource model and enums/sub-resources.
src/xurrent/products.py	Introduces Product resource model and depreciation enum.
src/xurrent/product_categories.py	Introduces ProductCategory resource model and rule-set enum.
src/xurrent/problems.py	Introduces Problem resource model and enums/sub-resources.
src/xurrent/people.py	Extends Person deserialization and adds multiple sub-resource helper methods; fixes update() return type.
src/xurrent/out_of_office_periods.py	Introduces OutOfOfficePeriod resource model and filters.
src/xurrent/organizations.py	Introduces/extends Organization resource model with lifecycle + sub-resources.
src/xurrent/knowledge_articles.py	Introduces KnowledgeArticle resource model and enums/sub-resources.
src/xurrent/holidays.py	Introduces Holiday resource model and calendar listing.
src/xurrent/effort_classes.py	Introduces EffortClass resource model and filter.
src/xurrent/custom_collections.py	Introduces CustomCollection resource model and element listing.
src/xurrent/custom_collection_elements.py	Introduces CustomCollectionElement resource model and filters.
src/xurrent/core.py	Adds helper endpoints (search, bulk_import, archive/trash/audit listings).
src/xurrent/contracts.py	Introduces Contract resource model and enums/sub-resources.
src/xurrent/configuration_items.py	Extends ConfigurationItem to deserialize product.
src/xurrent/closure_codes.py	Introduces ClosureCode resource model.
src/xurrent/calendars.py	Introduces/extends Calendar resource model and helper endpoints.
src/xurrent/init.py	Exposes many new classes/enums at package top-level.
pyproject.toml	Bumps version; updates author; adds dependency groups metadata.
Contributing.md	Adds a changelog documentation reminder.
CLAUDE.md	Adds repository guidance for Claude Code (setup, commands, architecture).
CHANGELOG.md	Documents newly added resources/methods and CI changes under Unreleased.
.gitignore	Adds uv.lock and .claude/ ignores; adjusts diff ignores.
.github/workflows/release.yml	Updates release automation steps and action versions; adds Node24 env flag.
.github/workflows/python-package.yml	Updates CI matrix, setup-python action, adds lint step, splits unit/integration tests.

Comments suppressed due to low confidence (1)

.github/workflows/release.yml:165

• The workflow creates a git tag without the v prefix (git tag ${{ ...effective_version }}) but creates a GitHub Release for v${{ ...effective_version }}. This mismatch will fail because the release tag won't exist (or will produce two different tags). Make the tag name consistent (either tag with v... or remove the v prefix in the release step).

      - name: Create Git Tag
        run: |
          git tag ${{ steps.effective-version.outputs.effective_version }}
          git push origin ${{ steps.effective-version.outputs.effective_version }}

      - name: Create GitHub Release
        if: env.python_changed == 'true'
        uses: softprops/action-gh-release@v2
        with:
          tag_name: v${{ steps.effective-version.outputs.effective_version }}
          name: Release v${{ steps.effective-version.outputs.effective_version }}
          body: "${{ steps.extract-changelog.outputs.release-notes }}"

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[fasteiner]

@copilot apply changes based on this feedback

[fasteiner]

@copilot apply changes based on this feedback

[Copilot]

Addressed in 9961d9a. XurrentApiHelper.search() now builds the query string with URL encoding, and the related unit tests were updated to cover spaces and reserved characters.

[fasteiner]

@copilot apply changes based on this feedback

[Copilot]

Addressed in 9961d9a. The release workflow now strips an optional leading v from the previous tag before splitting the version, so the forced patch bump works for both vX.Y.Z and X.Y.Z tags.

[Copilot]

@copilot please fix by implementing lazy loading (like shown in various examples in the code on co dependant classes):

Run # Stop the build on syntax errors or undefined names
...

Addressed in f76ecf4. I switched the affected cross-module annotations to lazy-loaded forward references with TYPE_CHECKING imports where needed, and fixed the undefined self/task references in tasks.py. The CI-equivalent flake8 gate now passes locally.