pydicomsorter


Namepydicomsorter JSON
Version 0.15.0 PyPI version JSON
download
home_pageNone
SummaryA Quick Tool For Sorting Dicom Files
upload_time2024-05-24 18:01:08
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords package pixi pydicomsorter python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pydicomsorter

[![codecov](https://codecov.io/gh/jjjermiah/PyDicomSorter/graph/badge.svg?token=tCcajRIGz9)](https://codecov.io/gh/jjjermiah/PyDicomSorter)
[![CI-CD](https://github.com/jjjermiah/PyDicomSorter/actions/workflows/main.yaml/badge.svg)](https://github.com/jjjermiah/PyDicomSorter/actions/workflows/main.yaml)
[![CodeFactor](https://www.codefactor.io/repository/github/jjjermiah/pydicomsorter/badge)](https://www.codefactor.io/repository/github/jjjermiah/pydicomsorter)

[![pixi-badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square)](https://github.com/prefix-dev/pixi)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)
[![Built with Material for MkDocs](https://img.shields.io/badge/mkdocs--material-gray?logo=materialformkdocs&style=flat-square)](https://github.com/squidfunk/mkdocs-material)


[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydicomsorter)](https://pypi.org/project/pydicomsorter/)
[![PyPI - Version](https://img.shields.io/pypi/v/PyDicomSorter)](https://pypi.org/project/pydicomsorter/)
[![PyPI - Format](https://img.shields.io/pypi/format/PyDicomSorter)](https://pypi.org/project/pydicomsorter/)
[![Downloads](https://static.pepy.tech/badge/pydicomsorter)](https://pepy.tech/project/pydicomsorter)


PyDicomSorter is a python package that sorts dicom files into a structured directory based on the dicom tags.

It can be used as a command line tool or as a python package.

## Installation

```bash
pip install PyDicomSorter
```


Testing the pydicom library to sort dicom files by patient name and study date.

> [!NOTE] none of this works yet

Designing should look like:

![Command output](./assets/help.png)

# DICOM data model

A Patient has one or more Studies, a Study has one or more Series, and a Series has one or more Instances.

```mermaid
graph TD
    A[Patient] --> B(Study)
    B --> C(Series)
    C --> D(Instance)

```

<!-- [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=jjjermiah)](https://github.com/jjjermiah/github-readme-stats) -->

<!-- [![GitHub Trends SVG](https://api.githubtrends.io/user/svg/jjjermiah/langs)](https://githubtrends.io) -->

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pydicomsorter",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Jermiah Joseph <jermiahjoseph98@gmail.com>",
    "keywords": "package, pixi, pydicomsorter, python",
    "author": null,
    "author_email": "Jermiah Joseph <jermiahjoseph98@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6d/8c/bee5ce078ad9f821426ded10b5b845f1c8ded73f45a1449bafe9217f3214/pydicomsorter-0.15.0.tar.gz",
    "platform": null,
    "description": "# pydicomsorter\n\n[![codecov](https://codecov.io/gh/jjjermiah/PyDicomSorter/graph/badge.svg?token=tCcajRIGz9)](https://codecov.io/gh/jjjermiah/PyDicomSorter)\n[![CI-CD](https://github.com/jjjermiah/PyDicomSorter/actions/workflows/main.yaml/badge.svg)](https://github.com/jjjermiah/PyDicomSorter/actions/workflows/main.yaml)\n[![CodeFactor](https://www.codefactor.io/repository/github/jjjermiah/pydicomsorter/badge)](https://www.codefactor.io/repository/github/jjjermiah/pydicomsorter)\n\n[![pixi-badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square)](https://github.com/prefix-dev/pixi)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&style=flat-square)](https://github.com/pre-commit/pre-commit)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square)](https://github.com/astral-sh/ruff)\n[![Built with Material for MkDocs](https://img.shields.io/badge/mkdocs--material-gray?logo=materialformkdocs&style=flat-square)](https://github.com/squidfunk/mkdocs-material)\n\n\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydicomsorter)](https://pypi.org/project/pydicomsorter/)\n[![PyPI - Version](https://img.shields.io/pypi/v/PyDicomSorter)](https://pypi.org/project/pydicomsorter/)\n[![PyPI - Format](https://img.shields.io/pypi/format/PyDicomSorter)](https://pypi.org/project/pydicomsorter/)\n[![Downloads](https://static.pepy.tech/badge/pydicomsorter)](https://pepy.tech/project/pydicomsorter)\n\n\nPyDicomSorter is a python package that sorts dicom files into a structured directory based on the dicom tags.\n\nIt can be used as a command line tool or as a python package.\n\n## Installation\n\n```bash\npip install PyDicomSorter\n```\n\n\nTesting the pydicom library to sort dicom files by patient name and study date.\n\n> [!NOTE] none of this works yet\n\nDesigning should look like:\n\n![Command output](./assets/help.png)\n\n# DICOM data model\n\nA Patient has one or more Studies, a Study has one or more Series, and a Series has one or more Instances.\n\n```mermaid\ngraph TD\n    A[Patient] --> B(Study)\n    B --> C(Series)\n    C --> D(Instance)\n\n```\n\n<!-- [![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)\n\n[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=jjjermiah)](https://github.com/jjjermiah/github-readme-stats) -->\n\n<!-- [![GitHub Trends SVG](https://api.githubtrends.io/user/svg/jjjermiah/langs)](https://githubtrends.io) -->\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Quick Tool For Sorting Dicom Files",
    "version": "0.15.0",
    "project_urls": {
        "changelog": "https://github.com/jjjermiah/pydicomsorter/blob/main/docs/CHANGELOG.md",
        "documentation": "https://jjjermiah.github.io/pydicomsorter/",
        "homepage": "https://github.com/jjjermiah/pydicomsorter",
        "issues": "https://github.com/jjjermiah/pydicomsorter/issues",
        "repository": "https://github.com/jjjermiah/pydicomsorter"
    },
    "split_keywords": [
        "package",
        " pixi",
        " pydicomsorter",
        " python"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7ea8c96f339c2c22e0548fe4e8823fad8b0ca97e6dbd98f794ee2090d18d0858",
                "md5": "738bed2d077bc76e744c1f8206058e25",
                "sha256": "221a7dd598193894d2445afc3d8c8a328ec1a5cedae68f278c4d2fa76edf87b6"
            },
            "downloads": -1,
            "filename": "pydicomsorter-0.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "738bed2d077bc76e744c1f8206058e25",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 14073,
            "upload_time": "2024-05-24T18:01:06",
            "upload_time_iso_8601": "2024-05-24T18:01:06.676567Z",
            "url": "https://files.pythonhosted.org/packages/7e/a8/c96f339c2c22e0548fe4e8823fad8b0ca97e6dbd98f794ee2090d18d0858/pydicomsorter-0.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6d8cbee5ce078ad9f821426ded10b5b845f1c8ded73f45a1449bafe9217f3214",
                "md5": "1d5cebd3217f4d8dcd59793c8ce6fe5c",
                "sha256": "12e8fa9c11a6f451806d5ead494cb5317e1c18eae7f75d0058d3bce941e188d1"
            },
            "downloads": -1,
            "filename": "pydicomsorter-0.15.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1d5cebd3217f4d8dcd59793c8ce6fe5c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 144365,
            "upload_time": "2024-05-24T18:01:08",
            "upload_time_iso_8601": "2024-05-24T18:01:08.415701Z",
            "url": "https://files.pythonhosted.org/packages/6d/8c/bee5ce078ad9f821426ded10b5b845f1c8ded73f45a1449bafe9217f3214/pydicomsorter-0.15.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-24 18:01:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jjjermiah",
    "github_project": "pydicomsorter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pydicomsorter"
}
        
Elapsed time: 0.25087s