dcmfile-parser


Namedcmfile-parser JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/y-menace/dcmfile-parser
Summaryparser for dcm files
upload_time2023-10-30 12:30:04
maintainer
docs_urlNone
authorMohitYadav
requires_python>=3.8
licenseMIT
keywords
VCS
bugtrack_url
requirements Jinja2
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Introduction

Parser for DCM files Data Conversion Format. The package has two main classes `DCMParser` and `DCMObject`, which provide a  toolkit to deal with DCM  files used in automotive software development. While the `DCMParser` is designed to read and interpret DCM files, the `DCMObject` allows for structured representation and manipulation of the parsed data.

## Install 

```python
pip install dcmfile_parser
```


## DCMParser

### Features

- **File Reading**: Read and parse DCM files.
- **Create DCM Object**: Translate raw DCM file content into structured data and create a DCMObject.

### Usage

1. **Parsing the DCM file**:
    ```python
    from dcmfile_parser import DCMParser , DCMObject
    dcmfile_parser = DCMParser("path/to/dcm/file")
    ```

2. **Creating a DCM object**:
    ```python
    dcm_obj = dcmfile_parser.create_dcm_object()
    ```

## DCMObject

### Features

- **Initialization and Attribute Sorting**: Auto-sorts parameters alphabetically by name upon initialization.
- **Parameter Management**: Remove, update (from another DcMObject), or add parameters.
- **Exporter**: Write the `DCMObject` back to a dcm file .

### Usage


1. **Write to a File**:
    ```python
    dcm_obj.write()
    ```
2. **Update Parameters from Another DCMObject**:
    ```python
    updated_names, missing_names = dcm_obj.update_from(other_dcm_obj)
    ```
3. **Add New Parameters from Another DCMObject**:
    ```python
    dcm_obj.add_new_parameters_from(other_dcm_obj)
    ```

4. **Remove a Parameter**:
    ```python
    result = dcm_obj.remove_parameter_by_name("parameter_name")
    ```

5. **Cleanup All Parameters**:
    ```python
    dcm_obj.cleanup_parameters()
    ```

### Dependencies
Specified in requirements.txt


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/y-menace/dcmfile-parser",
    "name": "dcmfile-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "MohitYadav",
    "author_email": "mohit.yadav.id.code.repos@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/ad/3c907fc43188fd53ee938bb5d7ae70683876133949e388063946c22a33d5/dcmfile-parser-0.0.2.tar.gz",
    "platform": null,
    "description": "## Introduction\n\nParser for DCM files Data Conversion Format. The package has two main classes `DCMParser` and `DCMObject`, which provide a  toolkit to deal with DCM  files used in automotive software development. While the `DCMParser` is designed to read and interpret DCM files, the `DCMObject` allows for structured representation and manipulation of the parsed data.\n\n## Install \n\n```python\npip install dcmfile_parser\n```\n\n\n## DCMParser\n\n### Features\n\n- **File Reading**: Read and parse DCM files.\n- **Create DCM Object**: Translate raw DCM file content into structured data and create a DCMObject.\n\n### Usage\n\n1. **Parsing the DCM file**:\n    ```python\n    from dcmfile_parser import DCMParser , DCMObject\n    dcmfile_parser = DCMParser(\"path/to/dcm/file\")\n    ```\n\n2. **Creating a DCM object**:\n    ```python\n    dcm_obj = dcmfile_parser.create_dcm_object()\n    ```\n\n## DCMObject\n\n### Features\n\n- **Initialization and Attribute Sorting**: Auto-sorts parameters alphabetically by name upon initialization.\n- **Parameter Management**: Remove, update (from another DcMObject), or add parameters.\n- **Exporter**: Write the `DCMObject` back to a dcm file .\n\n### Usage\n\n\n1. **Write to a File**:\n    ```python\n    dcm_obj.write()\n    ```\n2. **Update Parameters from Another DCMObject**:\n    ```python\n    updated_names, missing_names = dcm_obj.update_from(other_dcm_obj)\n    ```\n3. **Add New Parameters from Another DCMObject**:\n    ```python\n    dcm_obj.add_new_parameters_from(other_dcm_obj)\n    ```\n\n4. **Remove a Parameter**:\n    ```python\n    result = dcm_obj.remove_parameter_by_name(\"parameter_name\")\n    ```\n\n5. **Cleanup All Parameters**:\n    ```python\n    dcm_obj.cleanup_parameters()\n    ```\n\n### Dependencies\nSpecified in requirements.txt\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "parser for dcm files",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/y-menace/dcmfile-parser"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b23169655c284775e66b7fc20a3dc33a35616a912ba912fb015d01cb3013594",
                "md5": "2cc153230970aee865d550686957c23f",
                "sha256": "a5f0c4613e4388187206452a6e6c6bdc4d8c0a086e6641794f8dfb02f7aec385"
            },
            "downloads": -1,
            "filename": "dcmfile_parser-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2cc153230970aee865d550686957c23f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 14306,
            "upload_time": "2023-10-30T12:30:03",
            "upload_time_iso_8601": "2023-10-30T12:30:03.152844Z",
            "url": "https://files.pythonhosted.org/packages/6b/23/169655c284775e66b7fc20a3dc33a35616a912ba912fb015d01cb3013594/dcmfile_parser-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5ead3c907fc43188fd53ee938bb5d7ae70683876133949e388063946c22a33d5",
                "md5": "3b9aae38588de9d62ca709147c7c8054",
                "sha256": "db33a92dd37bc87cd6dc6dc46391397e394e3283fb33ea9605e0b1c0a8e8843d"
            },
            "downloads": -1,
            "filename": "dcmfile-parser-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3b9aae38588de9d62ca709147c7c8054",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14271,
            "upload_time": "2023-10-30T12:30:04",
            "upload_time_iso_8601": "2023-10-30T12:30:04.683854Z",
            "url": "https://files.pythonhosted.org/packages/5e/ad/3c907fc43188fd53ee938bb5d7ae70683876133949e388063946c22a33d5/dcmfile-parser-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-30 12:30:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "y-menace",
    "github_project": "dcmfile-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Jinja2",
            "specs": []
        }
    ],
    "lcname": "dcmfile-parser"
}
        
Elapsed time: 0.37324s