mite-extras


Namemite-extras JSON
Version 1.4.1 PyPI version JSON
download
home_pageNone
SummaryParsing, conversion, and validation functionality for Minimum Information about a Tailoring Enzyme (MITE) files.
upload_time2025-02-13 16:04:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseNone
keywords cheminformatics genomics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            mite_extras
==========

[![DOI](https://zenodo.org/badge/804997522.svg)](https://doi.org/10.5281/zenodo.13941745) [![PyPI version](https://badge.fury.io/py/mite-extras.svg)](https://badge.fury.io/py/mite-extras)

This package contains functionality to validate entries of the Minimum Information about a Tailoring Enzyme (MITE) repository.

This includes:

- Validation of the MITE json format (does the entry follow the `mite_schema` format)
- Validation of reaction SMARTS (does the reaction SMARTS lead to the expected product when applied to a specified substrate)
- Sanitation of SMILES and reaction SMARTS
- Fetching of NCBI GenPept/UniProtKB IDs

When used as CLI, `mite_extras` can automatically update MITE entries (see below). However, it can also be used as a library (e.g. as done in `mite_data`).

For more information, see the README of the [MITE-Standard organisation page](https://github.com/mite-standard).

## Installation

**Attention: this program has only been tested with Ubuntu Linux.**

### With `pip` from PyPI

- Install with `pip install mite_extras`

### With `hatch` from GitHub

- Install `python 3.12.x`
- Install hatch (e.g. with `pipx install hatch`)
- Download or clone the [repository](https://github.com/mmzdouc/mite_extras)
- Run `hatch -v env create`

## Quick Start: Example

### Run from command line:

To validate MITE entries or update them to a new schema version (requires `mite_extras` to be installed via `pip`).

- `mite_extras -i <input/> -o <output/>`

### Run with `hatch`:

Validate MITE entries or update them to a new schema version

- `hatch run mite_extras -i input/ -o output/`

## For devs

- Install developer dependencies with `hatch -v env create dev`
- Initialize `pre-commit` with `hatch run dev:pre-commit install`
- Run tests with `hatch run dev:pytest`
- Run CLI with `hatch run dev:mite_extras` and the appropriate options
- If necessary, remove the environment again with `hatch env remove dev`
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mite-extras",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "cheminformatics, genomics",
    "author": null,
    "author_email": "\"Mitja M. Zdouc\" <zdoucmm@gmail.com>, Adriano Rutz <adafede@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1c/78/d39ba06fc6cbe1439ebd653a7918ced4b2c3f051b886f63df7cae89ca417/mite_extras-1.4.1.tar.gz",
    "platform": null,
    "description": "mite_extras\n==========\n\n[![DOI](https://zenodo.org/badge/804997522.svg)](https://doi.org/10.5281/zenodo.13941745) [![PyPI version](https://badge.fury.io/py/mite-extras.svg)](https://badge.fury.io/py/mite-extras)\n\nThis package contains functionality to validate entries of the Minimum Information about a Tailoring Enzyme (MITE) repository.\n\nThis includes:\n\n- Validation of the MITE json format (does the entry follow the `mite_schema` format)\n- Validation of reaction SMARTS (does the reaction SMARTS lead to the expected product when applied to a specified substrate)\n- Sanitation of SMILES and reaction SMARTS\n- Fetching of NCBI GenPept/UniProtKB IDs\n\nWhen used as CLI, `mite_extras` can automatically update MITE entries (see below). However, it can also be used as a library (e.g. as done in `mite_data`).\n\nFor more information, see the README of the [MITE-Standard organisation page](https://github.com/mite-standard).\n\n## Installation\n\n**Attention: this program has only been tested with Ubuntu Linux.**\n\n### With `pip` from PyPI\n\n- Install with `pip install mite_extras`\n\n### With `hatch` from GitHub\n\n- Install `python 3.12.x`\n- Install hatch (e.g. with `pipx install hatch`)\n- Download or clone the [repository](https://github.com/mmzdouc/mite_extras)\n- Run `hatch -v env create`\n\n## Quick Start: Example\n\n### Run from command line:\n\nTo validate MITE entries or update them to a new schema version (requires `mite_extras` to be installed via `pip`).\n\n- `mite_extras -i <input/> -o <output/>`\n\n### Run with `hatch`:\n\nValidate MITE entries or update them to a new schema version\n\n- `hatch run mite_extras -i input/ -o output/`\n\n## For devs\n\n- Install developer dependencies with `hatch -v env create dev`\n- Initialize `pre-commit` with `hatch run dev:pre-commit install`\n- Run tests with `hatch run dev:pytest`\n- Run CLI with `hatch run dev:mite_extras` and the appropriate options\n- If necessary, remove the environment again with `hatch env remove dev`",
    "bugtrack_url": null,
    "license": null,
    "summary": "Parsing, conversion, and validation functionality for Minimum Information about a Tailoring Enzyme (MITE) files.",
    "version": "1.4.1",
    "project_urls": {
        "Homepage": "https://github.com/mite-standard/mite_extras",
        "Issues": "https://github.com/mite-standard/mite_extras/issues"
    },
    "split_keywords": [
        "cheminformatics",
        " genomics"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b812ff65938ee6183f9491a52a28555d196f35f73df6cefe82fab66c85d5e4ad",
                "md5": "e3e7a2e8827509d7e42b381680816b2e",
                "sha256": "39b576195e6b5d382455df00f9d00f68f0eb777434061c49f593699093b43b33"
            },
            "downloads": -1,
            "filename": "mite_extras-1.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e3e7a2e8827509d7e42b381680816b2e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 19775,
            "upload_time": "2025-02-13T16:04:37",
            "upload_time_iso_8601": "2025-02-13T16:04:37.780181Z",
            "url": "https://files.pythonhosted.org/packages/b8/12/ff65938ee6183f9491a52a28555d196f35f73df6cefe82fab66c85d5e4ad/mite_extras-1.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1c78d39ba06fc6cbe1439ebd653a7918ced4b2c3f051b886f63df7cae89ca417",
                "md5": "60429faae86da1ecda443095a70ea92f",
                "sha256": "a702c8de7a6015ebddb3e0aa757691efdbb0d27dd6dae9060dcf158131e1be8c"
            },
            "downloads": -1,
            "filename": "mite_extras-1.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "60429faae86da1ecda443095a70ea92f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 16451,
            "upload_time": "2025-02-13T16:04:39",
            "upload_time_iso_8601": "2025-02-13T16:04:39.058088Z",
            "url": "https://files.pythonhosted.org/packages/1c/78/d39ba06fc6cbe1439ebd653a7918ced4b2c3f051b886f63df7cae89ca417/mite_extras-1.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-13 16:04:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mite-standard",
    "github_project": "mite_extras",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mite-extras"
}
        
Elapsed time: 0.42895s