Refactor server package structure for Registry and Discovery#467
Merged
s-heppner merged 3 commits intoeclipse-basyx:developfrom Mar 1, 2026
Merged
Refactor server package structure for Registry and Discovery#467s-heppner merged 3 commits intoeclipse-basyx:developfrom
s-heppner merged 3 commits intoeclipse-basyx:developfrom
Conversation
Previously, the `server` `pyproject.toml` was located in `server/app`, which is different to how it is done in the `sdk`. This aligns the `server` `pyproject.toml` by moving it up one directory level, fixing the `version.py` path, and adding a top-level `__init__.py` for the `app` package. Fixes eclipse-basyx#466
s-heppner
changed the title
Previously, the `server` was built only with the `repository` API endpoints in mind. Since we now plan to also support `registry` and `discovery`, we need to adapt the `./server` project structure. For this reason, we did the following refactoring: - This moves the `pyproject.toml` from the `app` directory into the server project's top-level directory (`./server/pyproject.toml`). This aligns the `server` project directory with the `sdk` and the `compliance-tool` project directories. See eclipse-basyx#466 - This also moves the files for Docker image definition into the `./server/docker` subdirectories, where `./server/docker/common` are shared files across different Docker images, and `./server/docker/repository` and others contain the `Dockerfile`, as well as the image specific configuration files. See eclipse-basyx#468 - This moves the Docker `compose.yaml` into the `./server/example_configurations` and its subdirectories. Each example configuration should have its own `README.md` specifying what the example contains and how to run it. See eclipse-basyx#468 - Lastly, this moves the repository specific `main.py` to `.server/app/services/run_repository.py` And this adapts (hopefully) all relevant paths in all the different files accordingly. Fixes eclipse-basyx#466 Fixes eclipse-basyx#468
zrgt
requested changes
Mar 1, 2026
- Rename CI job server-package -> server-repository-docker to reflect that it specifically builds the repository Docker image - Narrow pycodestyle scope to 'app test' to match mypy, avoiding scanning docker/ and example_configurations/ directories - Fix broken #running-examples anchor and stale Dockerfile path in example_configurations/repository_standalone/README.md
zrgt
approved these changes
Mar 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Previously, the
serverwas built only with therepositoryAPIendpoints in mind. Since we now plan to also support
registryanddiscovery, we need to adapt the./serverproject structure.For this reason, we did the following refactoring:
pyproject.tomlfrom theappdirectory into theserver project's top-level directory (
./server/pyproject.toml).This aligns the
serverproject directory with thesdkand thecompliance-toolproject directories. See server: Fix package installation #466./server/dockersubdirectories, where./server/docker/commonareshared files across different Docker images, and
./server/docker/repositoryand others contain theDockerfile, aswell as the image specific configuration files. See Refactor server to allow for multiple services #468
compose.yamlinto the./server/example_configurationsand its subdirectories. Each exampleconfiguration should have its own
README.mdspecifying what theexample contains and how to run it. See Refactor server to allow for multiple services #468
main.pyto.server/app/services/run_repository.pyAnd this adapts (hopefully) all relevant paths in all the different
files accordingly.
Fixes #466
Fixes #468