Skip to main content
The westyx-nexus-sdk package is hosted on the GitLab PyPI Package Registry. It is public - no token is required to install.

1. Configure pip to look at the registry

The simplest option is to set an extra index URL globally for your user account:
Or pin per-project in requirements.txt:
No token is required - the registry is public.

2. Install

Requirements

  • Python 3.11 or newer
  • httpx >= 0.25 (pulled in automatically; the only runtime dependency)
  • (optional) Django 4.2+, FastAPI 0.100+, Flask 2.3+ - only required if you use the matching framework adapter

Importing

The framework adapters live in submodules:

Verifying connectivity

Before writing any code, confirm your endpoint and API key work with a plain curl:
A valid response returns a JSON snapshot with your configs, secrets, and flags. An HTTP 401 means the key is wrong; HTTP 404 means the slug is wrong. To watch the live SSE stream:
You should see event:resync arrive within a second. Press Ctrl+C to stop.

Troubleshooting

  • Could not find a version that satisfies the requirement westyx-nexus-sdk - pip didn’t see the GitLab index. Confirm pip config get global.extra-index-url returns your registry URL.
  • ModuleNotFoundError: No module named 'westyx_nexus.django' - you didn’t install the django extra. Run pip install "westyx-nexus-sdk[django]".
  • SSL / proxy errors - typical behind a corporate firewall. Ensure your build agents can reach gitlab.com directly, or set HTTPS_PROXY appropriately.