Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 1.46 KB

development.md

File metadata and controls

95 lines (65 loc) · 1.46 KB

Development guide

Local setup

This project uses pyproject.toml and uv.lock for dependency management.

Standard setup (PyPI dependencies)

pyenv local 3.11
make first-time-setup

Local SDK development setup

pyenv local 3.11
SOCKET_SDK_PATH=~/path/to/socketdev make first-time-local-setup

Default local SDK path is ../socketdev when SOCKET_SDK_PATH is not set.

Ongoing workflows

After dependency changes:

make update-deps

After pulling latest changes:

make sync-all

Run tests:

make test

Run lint/format checks:

make lint

Make targets

High-level:

  • make first-time-setup
  • make first-time-local-setup
  • make update-lock
  • make sync-all
  • make dev-setup

Implementation:

  • make local-dev
  • make setup
  • make sync
  • make clean
  • make test
  • make lint

Environment variables

Core:

  • SOCKET_SECURITY_API_TOKEN (also supports SOCKET_SECURITY_API_KEY, SOCKET_API_KEY, SOCKET_API_TOKEN)
  • SOCKET_SDK_PATH (default ../socketdev)

GitLab:

  • GITLAB_TOKEN
  • CI_JOB_TOKEN

Manual setup (without make)

python -m venv .venv
source .venv/bin/activate
uv sync
uv add --dev pre-commit
pre-commit install

Related docs