mb-cruise-migration
Migration scripts for migrating multibeam metadata from MB schema to CRUISE schema.
Usage: Migration Instructions
- Create a python file and import the
ci-cmg-mb-cruise-migrationpackage. - Create an instance of the "Migrator" class, passing in the path to your config file as the only parameter.
- Run the "migrate" method.
- An example run and start_background shell script is provided, which should be used to run the python script in the background.
- The package and it's dependencies will need to be installed prior to usage. This can be done with
python -m pip install ci-cmg-mb-cruise-migration.
NOTE: if enabling pooled connections for cruise db in config, oracle client libraries need to also be installed: https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html#optionally-install-oracle-client
Developing Project
Setup virtual environment
- setup virtualenv
- specify python installation for virtualenv to use
- activate the virtual environment
- verify python version and virtualenv
- install required modules
- verify they were installed with pip list
- deactivate the virtual environment
virtualenv migenv
virtualenv --python=</path/to/python> </path/to/new/virtualenv/>
source ./migenv/bin/activate
which python
python -V
python -m pip install --upgrade poetry
poetry install
pip list
deactivate
run tests
Many (most) tests are integration tests and require either one or both the MB or CRUISE schema docker containers be running.
To start docker containers:
from test dir:
./start-it.sh
To run tests (outside env):
from project root:
# runs all tests
./run_tests
# runs a test file
./run_tests <test filename>
To run tests (inside env):
cd tests
./start-it.sh
pytest
To stop docker containers:
from test dir:
./stop-it.sh
build project
- Update version in pyproject.toml either before or after release.
- If not already installed:
python -m pip install --upgrade build - Build distribution:
python -m build - If not already installed:
python -m pip install --upgrade twine - Upload to pypi:
twine upload dist/*
1 maintainer
Metadata
1 maintainer
Release files for ci-cmg-mb-cruise-migration 1.28.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ci_cmg_mb_cruise_migration-1.28.6.tar.gz | 714.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ci_cmg_mb_cruise_migration-1.28.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 802.5 kB
Release files / ci_cmg_mb_cruise_migration-1.28.6.tar.gz
| Download URL | ci_cmg_mb_cruise_migration-1.28.6.tar.gz |
|---|---|
| Size | 714.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2b8e7dde35313ed567bd413a27631df53ce16dd8297abc0d08aa46fe884801f6
|
|
BLAKE2b-256 checksum How to use checksums |
c635790d295dcb5f6bc1d1c4bd36f12691df93f587a75ca8be19bef007e3580c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / ci_cmg_mb_cruise_migration-1.28.6-py3-none-any.whl
| Download URL | ci_cmg_mb_cruise_migration-1.28.6-py3-none-any.whl |
|---|---|
| Size | 88.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fab9556baa8da9f616893ba6d4fe1a5d5fc2a119244c4541802c9cdb0cc5ba24
|
|
BLAKE2b-256 checksum How to use checksums |
f3255297e1c15257b625d19243d57b0eb60c82ab8e1261f7b283a7d895909a6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
