shadows

Name	shadows JSON
Version	0.1a0 JSON
	download
home_page
Summary	Low-memory data interfaces for scverse
upload_time	2023-10-31 15:58:54
maintainer
docs_url	None
author	Danila Bredikhin
requires_python	>=3.8
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <import img src="./docs/img/shadows_header.jpg" data-canonical-src="./docs/img/shadows_header.svg" width="700"/>

# Shadows

Shadows are on-disk interfaces for scverse data standards such as [AnnData](https://github.com/scverse/anndata) and [MuData](https://github.com/scverse/mudata).

It is an experimental project.

## Installation

```
pip install shadows
# or
pip install git+https://github.com/scverse/shadows
```

## Features

The shadows library aims to implement the following features:

- [x] **Shadow objects**: Read-only AnnDataShadow and MuDataShadow for HDF5 files.

- [x] AnnDataShadow and MuDataShadow for Zarr files.

- [ ] AnnDataShadow and MuDataShadow for Parquet-based serialization.

- [ ] Data shadows for Laminate files on S3 storage.


### Shadow objects

[Example notebook](/docs/examples/shadow-objects.ipynb) | [More features](/docs/examples/shadow-objects-features.ipynb)

Briefly, it simply works like this:

```py
from shadows import *
ash = AnnDataShadow("pbmc3k.h5ad")
msh = MuDataShadow("pbmc5k_citeseq.h5mu")
```



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "shadows",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Danila Bredikhin <danila.bredikhin@scverse.org>",
    "keywords": "",
    "author": "Danila Bredikhin",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/4a/33/63845bfcad41dafa41ca40dd203256e7438afe4fb641e5c2b280757a5909/shadows-0.1a0.tar.gz",
    "platform": null,
    "description": "<import img src=\"./docs/img/shadows_header.jpg\" data-canonical-src=\"./docs/img/shadows_header.svg\" width=\"700\"/>\n\n# Shadows\n\nShadows are on-disk interfaces for scverse data standards such as [AnnData](https://github.com/scverse/anndata) and [MuData](https://github.com/scverse/mudata).\n\nIt is an experimental project.\n\n## Installation\n\n```\npip install shadows\n# or\npip install git+https://github.com/scverse/shadows\n```\n\n## Features\n\nThe shadows library aims to implement the following features:\n\n- [x] **Shadow objects**: Read-only AnnDataShadow and MuDataShadow for HDF5 files.\n\n- [x] AnnDataShadow and MuDataShadow for Zarr files.\n\n- [ ] AnnDataShadow and MuDataShadow for Parquet-based serialization.\n\n- [ ] Data shadows for Laminate files on S3 storage.\n\n\n### Shadow objects\n\n[Example notebook](/docs/examples/shadow-objects.ipynb) | [More features](/docs/examples/shadow-objects-features.ipynb)\n\nBriefly, it simply works like this:\n\n```py\nfrom shadows import *\nash = AnnDataShadow(\"pbmc3k.h5ad\")\nmsh = MuDataShadow(\"pbmc5k_citeseq.h5mu\")\n```\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Low-memory data interfaces for scverse",
    "version": "0.1a0",
    "project_urls": {
        "Documentation": "https://scverse.github.io/shadows",
        "Home-page": "https://github.com/scverse/shadows",
        "Source": "https://github.com/scverse/shadows"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5da4e507b70a868a50665d6ab03ff93c37a984eb354d2092a5aaddd5c3a30f31",
                "md5": "82ea2e187806d071ec0ef53d4d7a6a18",
                "sha256": "4d5fd2d61348c1ed5ea0616ac0f0e6fc66872982683a5646c85199dfa517d3dd"
            },
            "downloads": -1,
            "filename": "shadows-0.1a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "82ea2e187806d071ec0ef53d4d7a6a18",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 14602,
            "upload_time": "2023-10-31T15:58:53",
            "upload_time_iso_8601": "2023-10-31T15:58:53.034843Z",
            "url": "https://files.pythonhosted.org/packages/5d/a4/e507b70a868a50665d6ab03ff93c37a984eb354d2092a5aaddd5c3a30f31/shadows-0.1a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a3363845bfcad41dafa41ca40dd203256e7438afe4fb641e5c2b280757a5909",
                "md5": "c76327439e1f6424c3d87b2fad6d4fe9",
                "sha256": "98e70611dd5591cac5a3a45e937f15ad667b6ad5b269c7a1f4cbe3c62911ace3"
            },
            "downloads": -1,
            "filename": "shadows-0.1a0.tar.gz",
            "has_sig": false,
            "md5_digest": "c76327439e1f6424c3d87b2fad6d4fe9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12142,
            "upload_time": "2023-10-31T15:58:54",
            "upload_time_iso_8601": "2023-10-31T15:58:54.967021Z",
            "url": "https://files.pythonhosted.org/packages/4a/33/63845bfcad41dafa41ca40dd203256e7438afe4fb641e5c2b280757a5909/shadows-0.1a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-31 15:58:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scverse",
    "github_project": "shadows",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "shadows"
}