Normal pip install of pixl CLI results in export directory being wrongly determined #318
Description
Definition of Done / Acceptance Criteria
- The system test should pass whether the pixl CLI packages are installed with or without the
-eoption topip install
Details and Comments
See main.yml workflow file:
system-test:
steps:
- name: Install Python dependencies
# The -e option is required here due to the way the
# code determines the export directory. See issue #318.
run: |
pip install -e pixl_core/
pip install -e cli/[test]
pip install -e pytest-pixl/
If the -e options are removed, the system test will fail.
For reference, the root docker-compose.yml:
services:
ehr-api:
volumes:
- ${PWD}/exports:/run/exports
This defines the export directory as in the root of the source code working tree on the GAE, as is intended.
The problem comes with how this directory is determined in the CLI code (cli/src/pixl_cli/_io.py):
HOST_EXPORT_ROOT_DIR = Path(__file__).parents[3] / "exports"
If you have done a "normal" install (pip install cli/), this location will be somewhere in your python libs directory, NOT in your source tree as expected. It's only when installed in editable mode, which is intended for dev use only, that these directories match up.
I guess we can keep installing with -e for now, it just seems kind of broken if your packages can't be installed in the standard way?
The most obvious way I see to fix it is to make it a config option, so it can be passed to docker compose so it can be mounted correctly and the CLI can pick up on it.