seqspec


Nameseqspec JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
SummaryA tool for working with sequencing specifications
upload_time2025-08-25 23:28:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT
keywords bioinformatics sequencing specifications
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # seqspec

![github version](https://img.shields.io/badge/Version-0.4.0-informational)
[![pypi version](https://img.shields.io/pypi/v/seqspec)](https://pypi.org/project/seqspec/0.4.0/)
![python versions](https://img.shields.io/pypi/pyversions/seqspec)
[![license](https://img.shields.io/pypi/l/seqspec)](LICENSE)

`seqspec`, short for "sequence specification" (pronounced "seek-speck"), is a file format that describes data generated from genomics experiments. Both the file format and `seqspec` tool [enable uniform processing](./docs/UNIFORM.md) of genomics data.

![alt text](docs/images/simple_file_structure.png)
**Figure 1**: Anatomy of a `seqspec` file.

We have multiple tutorials to get you up and running with `seqspec`:

1. Learn how to use `seqspec` to [standardize your genomics data preprocessing](docs/UNIFORM.ipynb).

2. Understand how to [manipulate `seqspec` files](docs/USING_SEQSPEC.ipynb) using the `seqspec` command-line tool.

## Citation

The `seqspec` format and tool are described in this [publication](https://doi.org/10.1093/bioinformatics/btae168). If you use `seqspec` please cite

```
Ali Sina Booeshaghi, Xi Chen, Lior Pachter, A machine-readable specification for genomics assays, Bioinformatics, Volume 40, Issue 4, April 2024, btae168.
```

`seqspec` was inspired by and builds off of the Teichmann Lab [Single Cell Genomics Library Structure](https://github.com/Teichlab/scg_lib_structs) by [Xi Chen](https://github.com/dbrg77).

## Documentation

- [Install `seqspec`: `docs/INSTALLATION.md`](docs/INSTALLATION.md)
- [Learn about the `seqspec` file format: `docs/DOCUMENTATION.md`](docs/SEQSPEC_FILE.md)
- [Learn about the `seqspec` tool: `docs/DOCUMENTATION.md`](docs/SEQSPEC_TOOL.md)
- [Learn about the `seqspec` specification : `docs/SPECIFICATION.md`](docs/SPECIFICATION.md)
- [Write a `seqspec`: `docs/TUTORIAL.md`](docs/TUTORIAL.md)
- [View example `seqspec` files: `https://www.sina.bio/seqspec-builder/assays.html`](https://www.sina.bio/seqspec-builder/assays.html)
- [Contribute a `seqspec` : `docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md)
- [Watch a YouTube video about `seqspec`](https://youtu.be/NSj6Vpzy8tU)
- [Read the manuscript that describes `seqspec`](https://doi.org/10.1093/bioinformatics/btae168)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "seqspec",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": "Sina Booeshaghi <abooesha@caltech.edu>",
    "keywords": "bioinformatics, sequencing, specifications",
    "author": null,
    "author_email": "Sina Booeshaghi <abooesha@caltech.edu>",
    "download_url": "https://files.pythonhosted.org/packages/7b/34/634c5217089734e4c4f96733a763bb5ecbd78790bbb1d7a6160e7d731310/seqspec-0.4.0.tar.gz",
    "platform": null,
    "description": "# seqspec\n\n![github version](https://img.shields.io/badge/Version-0.4.0-informational)\n[![pypi version](https://img.shields.io/pypi/v/seqspec)](https://pypi.org/project/seqspec/0.4.0/)\n![python versions](https://img.shields.io/pypi/pyversions/seqspec)\n[![license](https://img.shields.io/pypi/l/seqspec)](LICENSE)\n\n`seqspec`, short for \"sequence specification\" (pronounced \"seek-speck\"), is a file format that describes data generated from genomics experiments. Both the file format and `seqspec` tool [enable uniform processing](./docs/UNIFORM.md) of genomics data.\n\n![alt text](docs/images/simple_file_structure.png)\n**Figure 1**: Anatomy of a `seqspec` file.\n\nWe have multiple tutorials to get you up and running with `seqspec`:\n\n1. Learn how to use `seqspec` to [standardize your genomics data preprocessing](docs/UNIFORM.ipynb).\n\n2. Understand how to [manipulate `seqspec` files](docs/USING_SEQSPEC.ipynb) using the `seqspec` command-line tool.\n\n## Citation\n\nThe `seqspec` format and tool are described in this [publication](https://doi.org/10.1093/bioinformatics/btae168). If you use `seqspec` please cite\n\n```\nAli Sina Booeshaghi, Xi Chen, Lior Pachter, A machine-readable specification for genomics assays, Bioinformatics, Volume 40, Issue 4, April 2024, btae168.\n```\n\n`seqspec` was inspired by and builds off of the Teichmann Lab [Single Cell Genomics Library Structure](https://github.com/Teichlab/scg_lib_structs) by [Xi Chen](https://github.com/dbrg77).\n\n## Documentation\n\n- [Install `seqspec`: `docs/INSTALLATION.md`](docs/INSTALLATION.md)\n- [Learn about the `seqspec` file format: `docs/DOCUMENTATION.md`](docs/SEQSPEC_FILE.md)\n- [Learn about the `seqspec` tool: `docs/DOCUMENTATION.md`](docs/SEQSPEC_TOOL.md)\n- [Learn about the `seqspec` specification : `docs/SPECIFICATION.md`](docs/SPECIFICATION.md)\n- [Write a `seqspec`: `docs/TUTORIAL.md`](docs/TUTORIAL.md)\n- [View example `seqspec` files: `https://www.sina.bio/seqspec-builder/assays.html`](https://www.sina.bio/seqspec-builder/assays.html)\n- [Contribute a `seqspec` : `docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md)\n- [Watch a YouTube video about `seqspec`](https://youtu.be/NSj6Vpzy8tU)\n- [Read the manuscript that describes `seqspec`](https://doi.org/10.1093/bioinformatics/btae168)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A tool for working with sequencing specifications",
    "version": "0.4.0",
    "project_urls": {
        "Homepage": "https://github.com/sbooeshaghi/seqspec",
        "Repository": "https://github.com/sbooeshaghi/seqspec.git"
    },
    "split_keywords": [
        "bioinformatics",
        " sequencing",
        " specifications"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "25fb57e98c3d8d97b19d09d4f3db4ec8359a40bb2039d92d1e976deb417b79ba",
                "md5": "f09e4ee9639e8a7ef1aa6beb33172694",
                "sha256": "f3c620f095bba91af832dcac011a5fef66b2485cf5af0f7000a5cba67d45733b"
            },
            "downloads": -1,
            "filename": "seqspec-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f09e4ee9639e8a7ef1aa6beb33172694",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 76429,
            "upload_time": "2025-08-25T23:28:22",
            "upload_time_iso_8601": "2025-08-25T23:28:22.892836Z",
            "url": "https://files.pythonhosted.org/packages/25/fb/57e98c3d8d97b19d09d4f3db4ec8359a40bb2039d92d1e976deb417b79ba/seqspec-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7b34634c5217089734e4c4f96733a763bb5ecbd78790bbb1d7a6160e7d731310",
                "md5": "ed28af15b834c13962bee57b3d337bdf",
                "sha256": "ca1f3d6d8446de9fe0aae82c5226205c559ae930a9f8a1014d67bbcd92d61020"
            },
            "downloads": -1,
            "filename": "seqspec-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ed28af15b834c13962bee57b3d337bdf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 81626,
            "upload_time": "2025-08-25T23:28:24",
            "upload_time_iso_8601": "2025-08-25T23:28:24.315417Z",
            "url": "https://files.pythonhosted.org/packages/7b/34/634c5217089734e4c4f96733a763bb5ecbd78790bbb1d7a6160e7d731310/seqspec-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-25 23:28:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sbooeshaghi",
    "github_project": "seqspec",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "seqspec"
}
        
Elapsed time: 1.57684s