mfd-model


Namemfd-model JSON
Version 0.9.0 PyPI version JSON
download
home_pageNone
SummaryModule for handling models used across multiple MFDs (mostly Pydantic)
upload_time2025-07-10 12:30:44
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements mfd-common-libs
Travis-CI No Travis.
coveralls test coverage No coveralls.
            > [!IMPORTANT]  
> This project is under development. All source code and features on the main branch are for the purpose of testing or evaluation and not production ready.

# MFD Model
Module for handling Pydantic models used across multiple MFDs stored in subpackages.
The library utilizes the [project.optional-dependencies] section in pyproject.toml to specify optional dependencies for each subpackage

## Subpackages
Every subpackage can be installed separately by specifying the package name in square brackets after the main package name.
Structure:
```
├───<subpackage_name>
│   │   models.py
│   │   __init__.py
│   │   __version__.py
```

### config (used in pytest-mfd-config)
This subpackage contains models for configuration files. They are used in `pytest-mfd-config` to define configuration files and their structure.

### nvm
This subpackage contains models related with NVMs like `EETrack`, `Release`, ...\
They are used to handle upload / download / search of NVMs stored in NVMManager.

### artifacts_manager
This subpackage contains models for tested artifacts.

## Installation
To install 'config' models only use:
```bash
pip install mfd-model[config]
```

## How to add another subpackage? 
1. Create a new subpackage directory with the name of the subpackage.
2. Add `models.py` file with models definitions.
3. Add `__init__.py` file.
4. Add `__version__.py` file with version definition.
5. Update `pyproject.toml`:
   - add the requirements in [project.optional-dependencies] section, e.g.:
   ```
       data_processor = ["pydantic >= 2.0, < 3", "numpy >= 1.21.0"]  # Example dependencies
   ```

## OS supported:
* OS Independent

## Issue reporting

If you encounter any bugs or have suggestions for improvements, you're welcome to contribute directly or open an issue [here](https://github.com/intel/mfd-model/issues).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mfd-model",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "> [!IMPORTANT]  \n> This project is under development. All source code and features on the main branch are for the purpose of testing or evaluation and not production ready.\n\n# MFD Model\nModule for handling Pydantic models used across multiple MFDs stored in subpackages.\nThe library utilizes the [project.optional-dependencies] section in pyproject.toml to specify optional dependencies for each subpackage\n\n## Subpackages\nEvery subpackage can be installed separately by specifying the package name in square brackets after the main package name.\nStructure:\n```\n\u251c\u2500\u2500\u2500<subpackage_name>\n\u2502   \u2502   models.py\n\u2502   \u2502   __init__.py\n\u2502   \u2502   __version__.py\n```\n\n### config (used in pytest-mfd-config)\nThis subpackage contains models for configuration files. They are used in `pytest-mfd-config` to define configuration files and their structure.\n\n### nvm\nThis subpackage contains models related with NVMs like `EETrack`, `Release`, ...\\\nThey are used to handle upload / download / search of NVMs stored in NVMManager.\n\n### artifacts_manager\nThis subpackage contains models for tested artifacts.\n\n## Installation\nTo install 'config' models only use:\n```bash\npip install mfd-model[config]\n```\n\n## How to add another subpackage? \n1. Create a new subpackage directory with the name of the subpackage.\n2. Add `models.py` file with models definitions.\n3. Add `__init__.py` file.\n4. Add `__version__.py` file with version definition.\n5. Update `pyproject.toml`:\n   - add the requirements in [project.optional-dependencies] section, e.g.:\n   ```\n       data_processor = [\"pydantic >= 2.0, < 3\", \"numpy >= 1.21.0\"]  # Example dependencies\n   ```\n\n## OS supported:\n* OS Independent\n\n## Issue reporting\n\nIf you encounter any bugs or have suggestions for improvements, you're welcome to contribute directly or open an issue [here](https://github.com/intel/mfd-model/issues).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Module for handling models used across multiple MFDs (mostly Pydantic)",
    "version": "0.9.0",
    "project_urls": {
        "Changelog": "https://github.com/intel/mfd-model/blob/main/CHANGELOG.md",
        "Homepage": "https://github.com/intel/mfd",
        "Issues": "https://github.com/intel/mfd-model/issues",
        "Repository": "https://github.com/intel/mfd-model"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "297f0a76a995142f689a4166813415ecaf1965a6619cf23b4b9f299f9dae0650",
                "md5": "2a6dee075e0c2e2fa55f329e62cb2087",
                "sha256": "eac8b012ef576547f3a97ac46f8ff794b6d9ff976235175d3ac2a44c9d1967ab"
            },
            "downloads": -1,
            "filename": "mfd_model-0.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a6dee075e0c2e2fa55f329e62cb2087",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 11417,
            "upload_time": "2025-07-10T12:30:44",
            "upload_time_iso_8601": "2025-07-10T12:30:44.399597Z",
            "url": "https://files.pythonhosted.org/packages/29/7f/0a76a995142f689a4166813415ecaf1965a6619cf23b4b9f299f9dae0650/mfd_model-0.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 12:30:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "intel",
    "github_project": "mfd-model",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "mfd-common-libs",
            "specs": [
                [
                    ">=",
                    "1.11.0"
                ],
                [
                    "<",
                    "2"
                ]
            ]
        }
    ],
    "lcname": "mfd-model"
}
        
Elapsed time: 0.50921s