Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (68 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

107 lines (68 loc) · 3.21 KB

Contributing to APS Automation SDK

Installation

Prerequisites

  1. Install uv (fast Python package manager):

    pip install uv

    For other installation methods, see: https://docs.astral.sh/uv/getting-started/installation/

  2. Clone or download this repository

Install the SDK

From the project root directory:

# Install the package in editable mode
uv venv
source .venv/bin/activate   # on Windows: .venv\Scripts\activate
uv pip install -e .

Note: When running the Jupyter notebook in VS Code for the first time, you may be prompted to install the ipykernel package. Click "Install" or run:

uv add ipykernel

Configuration

Create a .env file in the project root with your APS credentials:

CLIENT_ID=your_client_id_here
CLIENT_SECRET=your_client_secret_here

Get your credentials from the APS Developer Portal.

For development and integration test variables you can also use .env.sample.dev as a template.

Test

We use two live tests for the SSA and ACC flow.

tests/integration/test_ssa_connection.py checks that the SDK can mint an SSA based 3lo token and read ACC tip storage from a source item.

tests/integration/test_ssa_only_autocad_list_layers_e2e.py runs the full end to end flow with signing. It sets nickname, uploads public key, deploys appbundle and activity, runs a public workitem, waits for success, and finalizes the output in ACC.

Use these environment variables.

APS_SSA_CLIENT_ID APS_SSA_CLIENT_SECRET APS_SSA_SERVICE_ACCOUNT_ID APS_SSA_KEY_ID APS_SSA_PRIVATE_KEY APS_SSA_SCOPE APS_TEST_PROJECT_ID APS_TEST_SOURCE_ITEM_URN

The end to end test also needs APS_TEST_FOLDER_ID.

For SSA setup and 3lo token generation read SSA + ACC Hub Setup.

End to end test reference tests/integration/test_ssa_only_autocad_list_layers_e2e.py.

AI-Assisted Development

You can use AI agents to speed up development, but they must always use repository context and APS documentation context.

Mandatory context files

Before changing code, make sure the agent reads these files and follows the links/references they contain (especially APS method references in AGENTS.md).

APS documentation requirement

If a method is added or modified, verify it against Autodesk APS docs before finalizing changes. Use AGENTS.md → ## Method-to-APS Documentation Matrix as the required mapping source.

Refresh repository context for agents

If you add or modify methods, regenerate llms-full.txt so external agents always have fresh context.

Run:

python skills/full-llm-export/scripts/export_repo_context.py --root . --output llms-full.txt

Or invoke the local skill:

  • $full-llm-export

Road Map

  • Improve type hints and docstrings
  • Add ACC examples
  • Add unit tests
  • Code style and governance will be added in further version