# Flywheel Migration Toolkit
**flywheel-migration** is a library that provides configurable parsing and
de-identification of foreign data.
## Development
Install the project using [poetry](https://python-poetry.org/) and enable
[pre-commit](https://pre-commit.com/).
```bash
poetry install
pre-commit install
```
## Testing
Tests are handled in pre-commit containers using
[qa-ci](https://gitlab.com/flywheel-io/tools/etc/qa-ci).
```bash
pre-commit run -a pytest
```
To run all pre-commit hooks, run:
```bash
pre-commit run -a
```
This will execute all hooks defined in [.pre-commit-config.yaml](.pre-commit-config.yaml).
Alternatively, you can run pytests natively by executing the poetry virtual environment,
then calling `pytest` with
```bash
poetry shell
pytest -vv tests/
```
To run individual tests natively such as `test_jitter_for_dicom` in
`test_dicom_file_profile.py`
```bash
poetry shell
pytest -vv tests/test_dicom_file_profile.py -sk test_jitter_for_dicom
```
## Release
Releases are handled with qa-ci automation. Head to
[Build >> Pipelines](https://gitlab.com/flywheel-io/public/migration-toolkit/-/pipelines)
page on repository's sidebar, then click on
[Run Pipeline](https://gitlab.com/flywheel-io/public/migration-toolkit/-/pipelines/new).
Select `Variable` in **Variables** dropdown, and entere `REASEASE` as **variable key**.
Set **variable value** to desired version and click on `Run Pipeline`. This will
create a new release MR that can than be reviewed and merged to deploy a new release.
## Documentation
Documentation is automatically handled by `pre-commit` hook `generate_docs`. The
HTML page is built into `public` and deployed to GitLab pages. Documentation is
available at Documentation at
<https://flywheel-io.gitlab.io/public/migration-toolkit/>.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/flywheel-io/public/migration-toolkit",
"name": "flywheel-migration",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "Flywheel, flywheel, data, migration, toolkit",
"author": "Flywheel",
"author_email": "support@flywheel.io",
"download_url": null,
"platform": null,
"description": "# Flywheel Migration Toolkit\n\n**flywheel-migration** is a library that provides configurable parsing and\nde-identification of foreign data.\n\n## Development\n\nInstall the project using [poetry](https://python-poetry.org/) and enable\n[pre-commit](https://pre-commit.com/).\n\n```bash\npoetry install\npre-commit install\n```\n\n## Testing\n\nTests are handled in pre-commit containers using\n[qa-ci](https://gitlab.com/flywheel-io/tools/etc/qa-ci).\n\n```bash\npre-commit run -a pytest\n```\n\nTo run all pre-commit hooks, run:\n\n```bash\npre-commit run -a\n```\n\nThis will execute all hooks defined in [.pre-commit-config.yaml](.pre-commit-config.yaml).\n\nAlternatively, you can run pytests natively by executing the poetry virtual environment,\nthen calling `pytest` with\n\n```bash\npoetry shell\npytest -vv tests/\n```\n\nTo run individual tests natively such as `test_jitter_for_dicom` in\n`test_dicom_file_profile.py`\n\n```bash\npoetry shell\npytest -vv tests/test_dicom_file_profile.py -sk test_jitter_for_dicom\n```\n\n## Release\n\nReleases are handled with qa-ci automation. Head to\n[Build >> Pipelines](https://gitlab.com/flywheel-io/public/migration-toolkit/-/pipelines)\npage on repository's sidebar, then click on\n[Run Pipeline](https://gitlab.com/flywheel-io/public/migration-toolkit/-/pipelines/new).\nSelect `Variable` in **Variables** dropdown, and entere `REASEASE` as **variable key**.\nSet **variable value** to desired version and click on `Run Pipeline`. This will\ncreate a new release MR that can than be reviewed and merged to deploy a new release.\n\n## Documentation\n\nDocumentation is automatically handled by `pre-commit` hook `generate_docs`. The\nHTML page is built into `public` and deployed to GitLab pages. Documentation is\navailable at Documentation at\n<https://flywheel-io.gitlab.io/public/migration-toolkit/>.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flywheel Migration Toolkit",
"version": "13.9.0",
"project_urls": {
"Documentation": "https://gitlab.com/flywheel-io/public/migration-toolkit",
"Homepage": "https://gitlab.com/flywheel-io/public/migration-toolkit",
"Repository": "https://gitlab.com/flywheel-io/public/migration-toolkit"
},
"split_keywords": [
"flywheel",
" flywheel",
" data",
" migration",
" toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5e1ec4d0d55aaa01359af0f4871d63db2b414f0c94ad394e12fba3a58057e62",
"md5": "66de37bd0bab99b4534d4f6ed71c02c6",
"sha256": "89552e57481e4bd73d7accac3f2dcf0d6b1cd010496d4e554357062b8140489a"
},
"downloads": -1,
"filename": "flywheel_migration-13.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66de37bd0bab99b4534d4f6ed71c02c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 82865,
"upload_time": "2024-10-02T19:13:27",
"upload_time_iso_8601": "2024-10-02T19:13:27.722851Z",
"url": "https://files.pythonhosted.org/packages/a5/e1/ec4d0d55aaa01359af0f4871d63db2b414f0c94ad394e12fba3a58057e62/flywheel_migration-13.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 19:13:27",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "flywheel-io",
"gitlab_project": "public",
"lcname": "flywheel-migration"
}
JSON