itpseq


Nameitpseq JSON
Version 0.0.1a14 PyPI version JSON
download
home_pageNone
SummaryA tool to process and analyze iTP-Seq datasets
upload_time2025-03-31 14:41:43
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords itp-seq inverse toeprinting ribosome
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            itpseq: A Python module and command-line tool for the analysis of iTP-Seq data.
==================================

[![PyPI Version](https://img.shields.io/pypi/v/itpseq.svg)](https://pypi.org/project/itpseq/)
[![License](https://img.shields.io/pypi/l/itpseq.svg)](https://github.com/t-renault/itpseq/blob/main/LICENSE)
[![Tests](https://github.com/t-renault/itpseq/actions/workflows/cross-platform-testing.yml/badge.svg)](https://github.com/t-renault/itpseq/actions/workflows/cross-platform-testing.yml)
[![Code Coverage](https://codecov.io/gh/t-renault/itpseq/branch/main/graph/badge.svg)](https://codecov.io/gh/t-renault/itpseq)
[![Downloads](https://pepy.tech/badge/itpseq)](https://pepy.tech/project/itpseq)

The latest documentation is available at [itpseq.readthedocs.io](https://itpseq.readthedocs.io).

Dependencies
------------
`itpseq` runs on Python 3.9+ on Linux, MacOS, and Windows.

Installation requires [regex](https://pypi.org/project/regex/),
[numpy](https://numpy.org/),
[pandas](https://pandas.pydata.org/),
[matplotlib](https://matplotlib.org/),
[seaborn](https://seaborn.pydata.org/),
[pydeseq2](https://pydeseq2.readthedocs.io/en/stable/),
[logomaker](https://logomaker.readthedocs.io/),
[Jinja2](https://jinja.palletsprojects.com/en/stable/),
[weasyprint](https://pypi.org/project/weasyprint/),
[ipython](https://ipython.org/),
[click](https://click.palletsprojects.com/),
and [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/).
The dependencies are installed automatically when installing from pip.


Installation
------------
The latest stable release (and required dependencies) can be installed from PyPI:

    pip install itpseq

To update the package to the latest version, run:

    pip install -U itpseq

After installation, if Python and pip are configured correctly, the "itpseq" command should be available in the terminal. If not, one should ensure the location of the executable is in the `PATH`. 

Citing
------


Known issues
------------
On MacOS and Windows, the "weasyprint" library 	that is used to produce the PDF version of the report seems to have an issue and exporting a PDF report is currently not possible.
It is nevertheless possible to produce an HTML report by running:

    itpseq report -o report.html data_directory 
  
in place of:

    itpseq report data_directory 

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "itpseq",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "iTP-Seq, inverse toeprinting, ribosome",
    "author": null,
    "author_email": "Thibaud Renault <thibaud.renault@u-bordeaux.fr>",
    "download_url": "https://files.pythonhosted.org/packages/5f/f8/59feb44e7ee390b7027cf887a7932d3c90305797a63c30b5cb71d0d2e667/itpseq-0.0.1a14.tar.gz",
    "platform": null,
    "description": "itpseq: A Python module and command-line tool for the analysis of iTP-Seq data.\n==================================\n\n[![PyPI Version](https://img.shields.io/pypi/v/itpseq.svg)](https://pypi.org/project/itpseq/)\n[![License](https://img.shields.io/pypi/l/itpseq.svg)](https://github.com/t-renault/itpseq/blob/main/LICENSE)\n[![Tests](https://github.com/t-renault/itpseq/actions/workflows/cross-platform-testing.yml/badge.svg)](https://github.com/t-renault/itpseq/actions/workflows/cross-platform-testing.yml)\n[![Code Coverage](https://codecov.io/gh/t-renault/itpseq/branch/main/graph/badge.svg)](https://codecov.io/gh/t-renault/itpseq)\n[![Downloads](https://pepy.tech/badge/itpseq)](https://pepy.tech/project/itpseq)\n\nThe latest documentation is available at [itpseq.readthedocs.io](https://itpseq.readthedocs.io).\n\nDependencies\n------------\n`itpseq` runs on Python 3.9+ on Linux, MacOS, and Windows.\n\nInstallation requires [regex](https://pypi.org/project/regex/),\n[numpy](https://numpy.org/),\n[pandas](https://pandas.pydata.org/),\n[matplotlib](https://matplotlib.org/),\n[seaborn](https://seaborn.pydata.org/),\n[pydeseq2](https://pydeseq2.readthedocs.io/en/stable/),\n[logomaker](https://logomaker.readthedocs.io/),\n[Jinja2](https://jinja.palletsprojects.com/en/stable/),\n[weasyprint](https://pypi.org/project/weasyprint/),\n[ipython](https://ipython.org/),\n[click](https://click.palletsprojects.com/),\nand [ipywidgets](https://ipywidgets.readthedocs.io/en/stable/).\nThe dependencies are installed automatically when installing from pip.\n\n\nInstallation\n------------\nThe latest stable release (and required dependencies) can be installed from PyPI:\n\n    pip install itpseq\n\nTo update the package to the latest version, run:\n\n    pip install -U itpseq\n\nAfter installation, if Python and pip are configured correctly, the \"itpseq\" command should be available in the terminal. If not, one should ensure the location of the executable is in the `PATH`. \n\nCiting\n------\n\n\nKnown issues\n------------\nOn MacOS and Windows, the \"weasyprint\" library \tthat is used to produce the PDF version of the report seems to have an issue and exporting a PDF report is currently not possible.\nIt is nevertheless possible to produce an HTML report by running:\n\n    itpseq report -o report.html data_directory \n  \nin place of:\n\n    itpseq report data_directory \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A tool to process and analyze iTP-Seq datasets",
    "version": "0.0.1a14",
    "project_urls": {
        "Documentation": "https://itpseq.readthedocs.io",
        "Homepage": "https://github.com/t-renault/itpseq",
        "Issues": "https://github.com/t-renault/itpseq/issues"
    },
    "split_keywords": [
        "itp-seq",
        " inverse toeprinting",
        " ribosome"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8bb5b2d404870d0a839b75efe0a462e1b411ba6420f287af42d1795c84704529",
                "md5": "2368a28c7a1f37c16dbd3c138818a4cc",
                "sha256": "c8e4550b9cb18a538e6d6f929138eb358964ac8d4ee8412dc5145f6fe7f8f196"
            },
            "downloads": -1,
            "filename": "itpseq-0.0.1a14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2368a28c7a1f37c16dbd3c138818a4cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 1872310,
            "upload_time": "2025-03-31T14:41:41",
            "upload_time_iso_8601": "2025-03-31T14:41:41.344116Z",
            "url": "https://files.pythonhosted.org/packages/8b/b5/b2d404870d0a839b75efe0a462e1b411ba6420f287af42d1795c84704529/itpseq-0.0.1a14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5ff859feb44e7ee390b7027cf887a7932d3c90305797a63c30b5cb71d0d2e667",
                "md5": "530fc82d5c53d9e28cea9ee7525fe88f",
                "sha256": "f4e306a79ee164593394feaf08b835d4bdff5cf848c70d135b6710f11f770e7d"
            },
            "downloads": -1,
            "filename": "itpseq-0.0.1a14.tar.gz",
            "has_sig": false,
            "md5_digest": "530fc82d5c53d9e28cea9ee7525fe88f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1831243,
            "upload_time": "2025-03-31T14:41:43",
            "upload_time_iso_8601": "2025-03-31T14:41:43.627841Z",
            "url": "https://files.pythonhosted.org/packages/5f/f8/59feb44e7ee390b7027cf887a7932d3c90305797a63c30b5cb71d0d2e667/itpseq-0.0.1a14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-31 14:41:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "t-renault",
    "github_project": "itpseq",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "itpseq"
}
        
Elapsed time: 0.54180s