CADS catalogue manager
>>> import cads_catalogueFor best experience create a new conda environment (e.g. DEVELOP) with Python 3.11:
conda create -n DEVELOP -c conda-forge python=3.11
conda activate DEVELOP
Before pushing to GitHub, run the following commands:
- Update conda environment:
make conda-env-update - Install this package:
pip install -e . - Sync with the latest template (optional):
make template-update - Run quality assurance checks:
make qa - Run tests:
make unit-tests - Run the static type checker:
make type-check - Build the documentation (see Sphinx tutorial):
make docs-build
The package cads-catalogue comes with its 'catalogue' database.
In case of database structure upgrade, developers must follow these steps:
- Update the new database structure modifying /cads_catalogue/database.py, using SQLAlchemy ORM technologies
- Execute from the cads-catalogue work folder:
alembic revision -m "message about the db modification" - The last command will create a new python file inside /alembic/versions. Fill the
upgradefunction with the operations that must be executed to migrate the database from the old structure to the new one. Keep in mind both DDL (structure modification) and DML (data modification) instructions. For reference, use https://alembic.sqlalchemy.org/en/latest/ops.html#ops. Similarly, do the same with thedowngradefunction. - Commit and push the modifications and the new file.
For details about the alembic migration tool, see the Alembic tutorial.
Copyright 2022, European Union.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.