# akey
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n akey --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install akey
```
### nbdev
``` sh
# activate conda environment
$ conda activate akey
# make sure the akey package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the akey package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/akey):
``` sh
$ pip install git+https://github.com/dsm-72/akey.git
```
or from [conda](https://anaconda.org/dsm-72/akey)
``` sh
$ conda install -c dsm-72 akey
```
or from [pypi](https://pypi.org/project/akey/)
``` sh
$ pip install akey
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/akey)
[pages](https://dsm-72.github.io/akey/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/akey) and
[pypi](https://pypi.org/project/akey/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/akey",
"name": "akey",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "akey extra extras single cell sc scanpy anndata RNA-seq seq",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/0d/e6/de6b331751d45e0f46b7524cf0da7a02868ece5701953a7f68b2ef0686fe/akey-0.0.5.tar.gz",
"platform": null,
"description": "# akey\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n akey --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install akey\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate akey\n\n# make sure the akey package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the akey package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/akey):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/akey.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/akey)\n\n``` sh\n$ conda install -c dsm-72 akey\n```\n\nor from [pypi](https://pypi.org/project/akey/)\n\n``` sh\n$ pip install akey\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/akey)\n[pages](https://dsm-72.github.io/akey/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/akey) and\n[pypi](https://pypi.org/project/akey/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "akey",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/dsm-72/akey"
},
"split_keywords": [
"akey",
"extra",
"extras",
"single",
"cell",
"sc",
"scanpy",
"anndata",
"rna-seq",
"seq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36b70de3045ab417eb4243a10df949d19990c85c5bd419d7a294743b9c481bba",
"md5": "8aa8b685b6b1ddd9470d222e99665068",
"sha256": "9311bbf0c3a29df59630dc7f3afa8cf12e1aa0f34913857d2152f55b43831a1f"
},
"downloads": -1,
"filename": "akey-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8aa8b685b6b1ddd9470d222e99665068",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14248,
"upload_time": "2024-04-04T12:59:00",
"upload_time_iso_8601": "2024-04-04T12:59:00.253080Z",
"url": "https://files.pythonhosted.org/packages/36/b7/0de3045ab417eb4243a10df949d19990c85c5bd419d7a294743b9c481bba/akey-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0de6de6b331751d45e0f46b7524cf0da7a02868ece5701953a7f68b2ef0686fe",
"md5": "0248ba0fd7e089166c739c8da39153f9",
"sha256": "7ae3275aa506f307ac0d6606d94ab3e24f27bd43f56a0694fbb89293d9909ddd"
},
"downloads": -1,
"filename": "akey-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "0248ba0fd7e089166c739c8da39153f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14589,
"upload_time": "2024-04-04T12:59:03",
"upload_time_iso_8601": "2024-04-04T12:59:03.351769Z",
"url": "https://files.pythonhosted.org/packages/0d/e6/de6b331751d45e0f46b7524cf0da7a02868ece5701953a7f68b2ef0686fe/akey-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 12:59:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "akey",
"github_not_found": true,
"lcname": "akey"
}
JSON
