PyMLST


NamePyMLST JSON
Version 2.1.6 PyPI version JSON
download
home_pagehttps://github.com/bvalot/pyMLST.git
Summarypython Mlst Local Search Tool
upload_time2024-03-20 14:43:10
maintainerNone
docs_urlNone
authorBenoit Valot
requires_python>=3.7.0
licenseGPLv3
keywords cgmlst mlst bacterial genome
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/PyMLST.svg)](https://pypi.org/project/PyMLST/)
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/pymlst/README.html)
[![Documentation Status](https://readthedocs.org/projects/pymlst/badge/?version=latest)](https://pymlst.readthedocs.io/en/latest/?badge=latest)

# pyMLST
![pyMLST](docs/source/logo.png "A Python Mlst Local Search Tool")

A Python Mlst Local Search Tool.

## Purpose
Bacterial typing is critical to unraveling the spread of pathogens.
For this purpose, data from next-generation sequencing are now widely used, with core multilocus sequence typing (cgMLST) or whole genome multilocus sequence typing (wgMLST) becoming the new standard.
These methods are an extension of the traditional MLST method, which uses a short list of housekeeping genes.
cgMLST and wgMLST use a large set of genes corresponding to the core or whole genome.
Similar to MLST, each unique sequence corresponds to a specific allele, and the combination of alleles determines the sequence type (ST) of the strain.

We have developed pyMLST to perform this task. Unlike other tools, it uses a local SQLite database to store allele sequences and MLST profiles.
This allows the collection of strains to be expanded iteratively. The input can be (i) an assembler-generated draft genome, (ii) the direct raw data, or (iii) other genomes stored in the sequence database.

## New version
V2.1:

- Use raw reads (FASTQ) directly with the kma integration (search2 and add2 command)

V2.0:

- An automatic import database mechanism to initiated cgMLST and MLST databases.
- A new process to fill incomplet genes using MAFFT alignment.
- A more complete command line interface with a sub-command system.
- A configuration file for defined PATH to external tools.
- An easy installation with pypi repository.


## Documentation
The details of installation, workflow and running parameters could be found on the [**documentation**](https://pymlst.readthedocs.io/en/latest/).


## Publications
If you use pyMLST, please cite the following paper:

Bignenet A. et al., Introduction and benchmarking of pyMLST:
open-source software for assessing bacterial clonality using core
genome MLST. 2023 Microbials Genomics, 9(11), 1126.
doi: [10.1099/mgen.0.001126](https://doi.org/10.1099/mgen.0.001126)


PyMLST v1 have been already use to analyse most of clinical bacteria:

 - [*Escherichia coli* and *Klebsiella pneumoniae*](https://doi.org/10.1016/j.cmi.2021.07.022)
 - [*Acinetobacter baumanii*](https://doi.org/10.1038/s41598-023-49268-x)
 - [*Pseudomonas aeruginosa*](https://doi.org/10.1016/j.jhin.2020.06.013)
 - [*Proteus mirabilis*](https://doi.org/10.1093/jac/dkz472)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bvalot/pyMLST.git",
    "name": "PyMLST",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7.0",
    "maintainer_email": null,
    "keywords": "cgMLST, MLST, bacterial genome",
    "author": "Benoit Valot",
    "author_email": "benoit.valot@univ-fcomte.fr",
    "download_url": "https://files.pythonhosted.org/packages/d9/20/714bafa3d1d2d2ec7bbed2ada2109fa23c00432f7b4c31892b216b5bc3b4/PyMLST-2.1.6.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/PyMLST.svg)](https://pypi.org/project/PyMLST/)\n[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/pymlst/README.html)\n[![Documentation Status](https://readthedocs.org/projects/pymlst/badge/?version=latest)](https://pymlst.readthedocs.io/en/latest/?badge=latest)\n\n# pyMLST\n![pyMLST](docs/source/logo.png \"A Python Mlst Local Search Tool\")\n\nA Python Mlst Local Search Tool.\n\n## Purpose\nBacterial typing is critical to unraveling the spread of pathogens.\nFor this purpose, data from next-generation sequencing are now widely used, with core multilocus sequence typing (cgMLST) or whole genome multilocus sequence typing (wgMLST) becoming the new standard.\nThese methods are an extension of the traditional MLST method, which uses a short list of housekeeping genes.\ncgMLST and wgMLST use a large set of genes corresponding to the core or whole genome.\nSimilar to MLST, each unique sequence corresponds to a specific allele, and the combination of alleles determines the sequence type (ST) of the strain.\n\nWe have developed pyMLST to perform this task. Unlike other tools, it uses a local SQLite database to store allele sequences and MLST profiles.\nThis allows the collection of strains to be expanded iteratively. The input can be (i) an assembler-generated draft genome, (ii) the direct raw data, or (iii) other genomes stored in the sequence database.\n\n## New version\nV2.1:\n\n- Use raw reads (FASTQ) directly with the kma integration (search2 and add2 command)\n\nV2.0:\n\n- An automatic import database mechanism to initiated cgMLST and MLST databases.\n- A new process to fill incomplet genes using MAFFT alignment.\n- A more complete command line interface with a sub-command system.\n- A configuration file for defined PATH to external tools.\n- An easy installation with pypi repository.\n\n\n## Documentation\nThe details of installation, workflow and running parameters could be found on the [**documentation**](https://pymlst.readthedocs.io/en/latest/).\n\n\n## Publications\nIf you use pyMLST, please cite the following paper:\n\nBignenet A. et al., Introduction and benchmarking of pyMLST:\nopen-source software for assessing bacterial clonality using core\ngenome MLST. 2023 Microbials Genomics, 9(11), 1126.\ndoi: [10.1099/mgen.0.001126](https://doi.org/10.1099/mgen.0.001126)\n\n\nPyMLST v1 have been already use to analyse most of clinical bacteria:\n\n - [*Escherichia coli* and *Klebsiella pneumoniae*](https://doi.org/10.1016/j.cmi.2021.07.022)\n - [*Acinetobacter baumanii*](https://doi.org/10.1038/s41598-023-49268-x)\n - [*Pseudomonas aeruginosa*](https://doi.org/10.1016/j.jhin.2020.06.013)\n - [*Proteus mirabilis*](https://doi.org/10.1093/jac/dkz472)\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "python Mlst Local Search Tool",
    "version": "2.1.6",
    "project_urls": {
        "Download": "https://github.com/bvalot/pyMLST/archive/refs/tags/2.1.6.tar.gz",
        "Homepage": "https://github.com/bvalot/pyMLST.git"
    },
    "split_keywords": [
        "cgmlst",
        " mlst",
        " bacterial genome"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd50964d6216670084035fbd5eba552322f6899802ac8603b8ba68e5806d64b8",
                "md5": "addfee5307f165eefe93ea5b82e23129",
                "sha256": "d0347f42dae250b5feaf837b5fa02112b47785cf471eb91dd6d9e0ceaa816407"
            },
            "downloads": -1,
            "filename": "PyMLST-2.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "addfee5307f165eefe93ea5b82e23129",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0",
            "size": 55352,
            "upload_time": "2024-03-20T14:43:08",
            "upload_time_iso_8601": "2024-03-20T14:43:08.865670Z",
            "url": "https://files.pythonhosted.org/packages/dd/50/964d6216670084035fbd5eba552322f6899802ac8603b8ba68e5806d64b8/PyMLST-2.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d920714bafa3d1d2d2ec7bbed2ada2109fa23c00432f7b4c31892b216b5bc3b4",
                "md5": "5cccd27a496fac9ae185bfe388705157",
                "sha256": "9bd57046fd295d6011595c3618624f8b160e780ad0aa71b08799eb41758cc1c2"
            },
            "downloads": -1,
            "filename": "PyMLST-2.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "5cccd27a496fac9ae185bfe388705157",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0",
            "size": 41468,
            "upload_time": "2024-03-20T14:43:10",
            "upload_time_iso_8601": "2024-03-20T14:43:10.875543Z",
            "url": "https://files.pythonhosted.org/packages/d9/20/714bafa3d1d2d2ec7bbed2ada2109fa23c00432f7b4c31892b216b5bc3b4/PyMLST-2.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-20 14:43:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bvalot",
    "github_project": "pyMLST",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pymlst"
}
        
Elapsed time: 3.92645s