adorsys / adorsys/status-list-server

Make demo environment and dependencies platform-agnostic

Đang mở
#500 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation enhancement
Ngôn ngữ chính
Rust
Star
22
Fork
5
Merge trung bình
2 ngày 11 giờ
Pull request đã merge (30 ngày)
47

Mô tả

## Objective

Decouple the interactive demo notebooks in `demo/` from Linux-specific conda build locks so that developers and evaluators can run the demo workflows on macOS (Apple Silicon / Intel), Linux, and Windows.

## Context

1. `demo/environment.yml` was generated via `conda env export` on an Ubuntu x86_64 machine. It contains locked OS-specific packages (`_libgcc_mutex`, `ld_impl_linux-64`, `libgcc`, `libgomp`, `libstdcxx-ng`, `xorg-libx11`, etc.) and architecture-specific build tags (`py310h06a4308_0`).
2. Attempting to run `conda env create -f environment.yml` on macOS or Windows fails with `ResolvePackageNotFound`.
3. Evaluators without Conda currently lack a standard Python virtual environment workflow (`requirements.txt`).

## Deliverables

- [ ] **Platform-agnostic Conda environment:**
- Clean `demo/environment.yml`: remove all OS-specific packages and build hashes, retaining only top-level required packages with version bounds (`python>=3.10,<3.13`, `jupyterlab>=4.0`, `notebook>=7.0`, `ipykernel`, `requests>=2.31.0`, `pyjwt>=2.8.0`, `cryptography>=42.0.0`, `cbor2>=5.6.0`, `python-dotenv>=1.0.0`).
- [ ] **Standard Python requirements.txt:**
- Provide `demo/requirements.txt` for standard `python -m venv .venv && pip install -r requirements.txt` setups.
- [ ] **Cross-platform verification:**
- Ensure paths in `demo/workflows/helpers/utils.py` and `fixtures.py` use `pathlib.Path` and handle line endings and URLs portably.
- [ ] **Documentation update:**
- Update `demo/README.md` to document both Conda and standard Python virtual environment workflows across macOS, Linux, and Windows.

## Acceptance Criteria

- [ ] `conda env create -f environment.yml` succeeds on macOS (arm64 & x86_64), Linux, and Windows.
- [ ] `pip install -r requirements.txt` succeeds in a clean Python 3.10+ virtual environment on all operating systems.
- [ ] All 4 Jupyter notebooks in `demo/workflows/` execute cleanly against a running server.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.