# xst
<!-- 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 bnx --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install bnx
```
### nbdev
``` sh
# activate conda environment
$ conda activate bnx
# make sure the bnx package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the bnx 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/bnx):
``` sh
$ pip install git+https://github.com/dsm-72/bnx.git
```
or from [conda](https://anaconda.org/dsm-72/bnx)
``` sh
$ conda install -c dsm-72 bnx
```
or from [pypi](https://pypi.org/project/bnx/)
``` sh
$ pip install bnx
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/bnx)
[pages](https://dsm-72.github.io/bnx/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/bnx) and
[pypi](https://pypi.org/project/bnx/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/xst",
"name": "xst",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "xst exsta exstas xstpect argspec nbdev utils utilities jupyter",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ce/32/2af2d0bcbb6495c81f07c9a48d735d5452f8e7d96353f02855dca4242d17/xst-0.0.5.tar.gz",
"platform": null,
"description": "# xst\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 bnx --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install bnx\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate bnx\n\n# make sure the bnx 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 bnx 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/bnx):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/bnx.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/bnx)\n\n``` sh\n$ conda install -c dsm-72 bnx\n```\n\nor from [pypi](https://pypi.org/project/bnx/)\n\n``` sh\n$ pip install bnx\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/bnx)\n[pages](https://dsm-72.github.io/bnx/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/bnx) and\n[pypi](https://pypi.org/project/bnx/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "xst",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/dsm-72/xst"
},
"split_keywords": [
"xst",
"exsta",
"exstas",
"xstpect",
"argspec",
"nbdev",
"utils",
"utilities",
"jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6be11e6c98bd3ab8d5d6a6931e2bd67bee0373cde795eef0d9f010557c07823",
"md5": "d6077c6d9d3a3288ab953e033def554f",
"sha256": "de2acd69eaed5d8970202d405cd4e79c0717e92679574cdb908c7552b07d8805"
},
"downloads": -1,
"filename": "xst-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6077c6d9d3a3288ab953e033def554f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10140,
"upload_time": "2023-10-30T13:20:42",
"upload_time_iso_8601": "2023-10-30T13:20:42.945576Z",
"url": "https://files.pythonhosted.org/packages/a6/be/11e6c98bd3ab8d5d6a6931e2bd67bee0373cde795eef0d9f010557c07823/xst-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce322af2d0bcbb6495c81f07c9a48d735d5452f8e7d96353f02855dca4242d17",
"md5": "49d342ca952dc6b7528897186b0cd70f",
"sha256": "6756116b9610e7b864625ee0d50fe0f5d91fa519b3130369440819ae72f83e5b"
},
"downloads": -1,
"filename": "xst-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "49d342ca952dc6b7528897186b0cd70f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10175,
"upload_time": "2023-10-30T13:20:44",
"upload_time_iso_8601": "2023-10-30T13:20:44.051868Z",
"url": "https://files.pythonhosted.org/packages/ce/32/2af2d0bcbb6495c81f07c9a48d735d5452f8e7d96353f02855dca4242d17/xst-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 13:20:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "xst",
"github_not_found": true,
"lcname": "xst"
}
JSON
