Fix/requirements into setuppy
-
Review changes -
-
Download -
Patches
-
Plain diff
Description
- Removes the
requirements.txt
file - Move requirements into setup.py
- Reformat setup.py
- Update README to reflect no longer using requirements.txt
- Update CI to use new setup
- Generates venv for tests each time to ensure runner local env is not used
- Added
--ignore=tests/legacy
flag to pytest to ignore legacy test dir - Added
--cov=cal_tools
and--cov=xfel_calibrate
to get coverage output for both modules - Added ssh key variable to CI, added
.setup-ssh-euxfel-gitlab
template to CI
- Change internal dependencies to use SSH instead of files (this is now possible as xsoft has a keypair on gitlab)
These changes make the installation of the package a bit more standard, removes the step of having to run two install commands (one for requirements.txt
, and one for .
), and let us use extras to define additional optional dependencies (e.g. test, dev, etc...).
How Has This Been Tested?
Tested locally by running pip install
without extras, with test
, with dev
, and with test,dev
, then ran the pytests to check that everything was still working correctly.
Also updated the CI definition to use the new setup style, so the tests also executed with the pipeline.
Relevant Documents (optional)
Types of changes
- Bug fix (non-breaking change which fixes an issue)
Checklist:
-
My code follows the code style of this project. -
My change requires a change to the documentation. -
I have updated the documentation accordingly.
Reviewers
Notes:
For our local dependencies the name of the package doesn't match the name of the repository, so I have to explicitly write out the name, and then use the git ssh url as a target, e.g. iCalibrationDB @ git+ssh://git@git.xfel.eu:10022/detectors/cal_db_interactive.git@2.0.1
. @kluyvert does this look correct?
Merge request reports
- version 21d1a93acc
- version 20c1cbb2f7
- version 19bfb158f9
- version 18bfb158f9
- version 17de12cc78
- version 165dceb67c
- version 15e10a5057
- version 14e10a5057
- version 137457b756
- version 12bb50f032
- version 11bb50f032
- version 104cc57009
- version 97c96348b
- version 87c96348b
- version 7853b74a3
- version 6c636d352
- version 572d4cbc1
- version 4b1e9f920
- version 3b1e9f920
- version 217f38f37
- version 1a3cfe0b6
- master (base)
- latest version952c9f5e32 commits,
- version 21d1a93acc32 commits,
- version 20c1cbb2f731 commits,
- version 19bfb158f928 commits,
- version 18bfb158f928 commits,
- version 17de12cc7828 commits,
- version 165dceb67c25 commits,
- version 15e10a505723 commits,
- version 14e10a505723 commits,
- version 137457b75622 commits,
- version 12bb50f03221 commits,
- version 11bb50f03221 commits,
- version 104cc5700920 commits,
- version 97c96348b18 commits,
- version 87c96348b18 commits,
- version 7853b74a317 commits,
- version 6c636d35216 commits,
- version 572d4cbc115 commits,
- version 4b1e9f92014 commits,
- version 3b1e9f92014 commits,
- version 217f38f3713 commits,
- version 1a3cfe0b612 commits,
- Side-by-side
- Inline