nf-core


Namenf-core JSON
Version 3.1.1 PyPI version JSON
download
home_pagehttps://github.com/nf-core/tools
SummaryHelper tools for use with nf-core Nextflow pipelines.
upload_time2024-12-20 13:00:23
maintainerNone
docs_urlNone
authorPhil Ewels
requires_python<4,>=3.8
licenseMIT
keywords nf-core nextflow bioinformatics workflow pipeline biology sequencing ngs next generation sequencing
VCS
bugtrack_url
requirements click filetype GitPython PyGithub jinja2 jsonschema markdown packaging pillow pdiff pre-commit prompt_toolkit pydantic pyyaml questionary refgenie requests requests_cache rich-click rich rocrate repo2rocrate tabulate textual trogon pdiff ruamel.yaml
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <h1>
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nf-core/tools/main/docs/images/nfcore-tools_logo_dark.png">
    <img alt="nf-core/tools" src="https://raw.githubusercontent.com/nf-core/tools/main/docs/images/nfcore-tools_logo_light.png">
  </picture>
</h1><!-- omit in toc -->

[![Python tests](https://github.com/nf-core/tools/workflows/Python%20tests/badge.svg?branch=main&event=push)](https://github.com/nf-core/tools/actions?query=workflow%3A%22Python+tests%22+branch%3Amain)
[![codecov](https://codecov.io/gh/nf-core/tools/branch/main/graph/badge.svg)](https://codecov.io/gh/nf-core/tools)
[![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)

[![install with Bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](https://bioconda.github.io/recipes/nf-core/README.html)
[![install with PyPI](https://img.shields.io/badge/install%20with-PyPI-blue.svg)](https://pypi.org/project/nf-core/)
[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23tools-4A154B?logo=slack)](https://nfcore.slack.com/channels/tools)

A python package with helper tools for the nf-core community.

The nf-core tools package is written in Python and can be imported and used within other packages.
For documentation of the internal Python functions, please refer to the [Tools Python API docs](https://nf-co.re/tools/docs/).

## Installation

For full installation instructions, please see the [nf-core documentation](https://nf-co.re/docs/nf-core-tools/installation).
Below is a quick-start for those who know what they're doing:

### Bioconda

Install [from Bioconda](https://bioconda.github.io/recipes/nf-core/README.html):

```bash
conda install nf-core
```

Alternatively, you can create a new environment with both nf-core/tools and nextflow:

```bash
conda create --name nf-core python=3.12 nf-core nextflow
conda activate nf-core
```

### Python Package Index

Install [from PyPI](https://pypi.python.org/pypi/nf-core/):

```bash
pip install nf-core
```

### Development version

```bash
pip install --upgrade --force-reinstall git+https://github.com/nf-core/tools.git@dev
```

If editing, fork and clone the repo, then install as follows:

```bash
pip install --upgrade -r requirements-dev.txt -e .
```

## Contributions and Support

If you would like to contribute to this package, please see the [contributing guidelines](.github/CONTRIBUTING.md).

For further information or help, don't hesitate to get in touch on the [Slack `#tools` channel](https://nfcore.slack.com/channels/tools) (you can join with [this invite](https://nf-co.re/join/slack)).

## Citation

If you use `nf-core tools` in your work, please cite the `nf-core` publication as follows:

> **The nf-core framework for community-curated bioinformatics pipelines.**
>
> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.
>
> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nf-core/tools",
    "name": "nf-core",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "nf-core, nextflow, bioinformatics, workflow, pipeline, biology, sequencing, NGS, next generation sequencing",
    "author": "Phil Ewels",
    "author_email": "phil.ewels@scilifelab.se",
    "download_url": "https://files.pythonhosted.org/packages/4a/1b/d9126d87bfa592ac02828b85ef9843ec943208d4b9c179c7722a61bdb04c/nf_core-3.1.1.tar.gz",
    "platform": null,
    "description": "<h1>\n  <picture>\n    <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/nf-core/tools/main/docs/images/nfcore-tools_logo_dark.png\">\n    <img alt=\"nf-core/tools\" src=\"https://raw.githubusercontent.com/nf-core/tools/main/docs/images/nfcore-tools_logo_light.png\">\n  </picture>\n</h1><!-- omit in toc -->\n\n[![Python tests](https://github.com/nf-core/tools/workflows/Python%20tests/badge.svg?branch=main&event=push)](https://github.com/nf-core/tools/actions?query=workflow%3A%22Python+tests%22+branch%3Amain)\n[![codecov](https://codecov.io/gh/nf-core/tools/branch/main/graph/badge.svg)](https://codecov.io/gh/nf-core/tools)\n[![code style: prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n\n[![install with Bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](https://bioconda.github.io/recipes/nf-core/README.html)\n[![install with PyPI](https://img.shields.io/badge/install%20with-PyPI-blue.svg)](https://pypi.org/project/nf-core/)\n[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23tools-4A154B?logo=slack)](https://nfcore.slack.com/channels/tools)\n\nA python package with helper tools for the nf-core community.\n\nThe nf-core tools package is written in Python and can be imported and used within other packages.\nFor documentation of the internal Python functions, please refer to the [Tools Python API docs](https://nf-co.re/tools/docs/).\n\n## Installation\n\nFor full installation instructions, please see the [nf-core documentation](https://nf-co.re/docs/nf-core-tools/installation).\nBelow is a quick-start for those who know what they're doing:\n\n### Bioconda\n\nInstall [from Bioconda](https://bioconda.github.io/recipes/nf-core/README.html):\n\n```bash\nconda install nf-core\n```\n\nAlternatively, you can create a new environment with both nf-core/tools and nextflow:\n\n```bash\nconda create --name nf-core python=3.12 nf-core nextflow\nconda activate nf-core\n```\n\n### Python Package Index\n\nInstall [from PyPI](https://pypi.python.org/pypi/nf-core/):\n\n```bash\npip install nf-core\n```\n\n### Development version\n\n```bash\npip install --upgrade --force-reinstall git+https://github.com/nf-core/tools.git@dev\n```\n\nIf editing, fork and clone the repo, then install as follows:\n\n```bash\npip install --upgrade -r requirements-dev.txt -e .\n```\n\n## Contributions and Support\n\nIf you would like to contribute to this package, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#tools` channel](https://nfcore.slack.com/channels/tools) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citation\n\nIf you use `nf-core tools` in your work, please cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Helper tools for use with nf-core Nextflow pipelines.",
    "version": "3.1.1",
    "project_urls": {
        "Homepage": "https://github.com/nf-core/tools"
    },
    "split_keywords": [
        "nf-core",
        " nextflow",
        " bioinformatics",
        " workflow",
        " pipeline",
        " biology",
        " sequencing",
        " ngs",
        " next generation sequencing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0543993f1a4aeb7b2a3ff0bc91471d94daca940dc343363c1fc237f590da79c7",
                "md5": "42354b06c2947206e30b4fa9992cec28",
                "sha256": "9c06196a2bf841ed0770f487a05e7712d530fd5db3d7fe0e0cc4ac68b97b9df8"
            },
            "downloads": -1,
            "filename": "nf_core-3.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "42354b06c2947206e30b4fa9992cec28",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 635537,
            "upload_time": "2024-12-20T13:00:21",
            "upload_time_iso_8601": "2024-12-20T13:00:21.154805Z",
            "url": "https://files.pythonhosted.org/packages/05/43/993f1a4aeb7b2a3ff0bc91471d94daca940dc343363c1fc237f590da79c7/nf_core-3.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a1bd9126d87bfa592ac02828b85ef9843ec943208d4b9c179c7722a61bdb04c",
                "md5": "3a68a2a1a73de632f1b325892ffeb0e7",
                "sha256": "8105d75ef0535ccf462757e1a49d570027edf7189c11754b0929a7c0131e3264"
            },
            "downloads": -1,
            "filename": "nf_core-3.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3a68a2a1a73de632f1b325892ffeb0e7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 531362,
            "upload_time": "2024-12-20T13:00:23",
            "upload_time_iso_8601": "2024-12-20T13:00:23.223970Z",
            "url": "https://files.pythonhosted.org/packages/4a/1b/d9126d87bfa592ac02828b85ef9843ec943208d4b9c179c7722a61bdb04c/nf_core-3.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 13:00:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nf-core",
    "github_project": "tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "click",
            "specs": []
        },
        {
            "name": "filetype",
            "specs": []
        },
        {
            "name": "GitPython",
            "specs": []
        },
        {
            "name": "PyGithub",
            "specs": []
        },
        {
            "name": "jinja2",
            "specs": []
        },
        {
            "name": "jsonschema",
            "specs": [
                [
                    ">=",
                    "4.0"
                ]
            ]
        },
        {
            "name": "markdown",
            "specs": [
                [
                    ">=",
                    "3.3"
                ]
            ]
        },
        {
            "name": "packaging",
            "specs": []
        },
        {
            "name": "pillow",
            "specs": []
        },
        {
            "name": "pdiff",
            "specs": []
        },
        {
            "name": "pre-commit",
            "specs": []
        },
        {
            "name": "prompt_toolkit",
            "specs": [
                [
                    "<=",
                    "3.0.48"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "2.2.1"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": []
        },
        {
            "name": "questionary",
            "specs": [
                [
                    ">=",
                    "2.0.1"
                ]
            ]
        },
        {
            "name": "refgenie",
            "specs": []
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "requests_cache",
            "specs": []
        },
        {
            "name": "rich-click",
            "specs": [
                [
                    "==",
                    "1.8.*"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    ">=",
                    "13.3.1"
                ]
            ]
        },
        {
            "name": "rocrate",
            "specs": []
        },
        {
            "name": "repo2rocrate",
            "specs": []
        },
        {
            "name": "tabulate",
            "specs": []
        },
        {
            "name": "textual",
            "specs": [
                [
                    "==",
                    "0.71.0"
                ]
            ]
        },
        {
            "name": "trogon",
            "specs": []
        },
        {
            "name": "pdiff",
            "specs": []
        },
        {
            "name": "ruamel.yaml",
            "specs": []
        }
    ],
    "lcname": "nf-core"
}
Phil Ewels
Elapsed time: 0.46686s