# xall
<!-- 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/xtr",
"name": "xtr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "xtr extra extras xtrpect argspec nbdev utils utilities jupyter",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/a0/d9/2bde6df056ce67131e01d750a6d3acc2d19b192d67307319cdeda963f9e8/xtr-0.0.7.tar.gz",
"platform": null,
"description": "# xall\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": "xtr",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/dsm-72/xtr"
},
"split_keywords": [
"xtr",
"extra",
"extras",
"xtrpect",
"argspec",
"nbdev",
"utils",
"utilities",
"jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5b56caeedf8950e60685a5b523023b463d65ee655e3f3466aa6ffc5b67a2664c",
"md5": "29a894436840b431ede01c4a5df74649",
"sha256": "efcf56ed435e005db9f121834a1bad25dfd8da2186401f4fdeba095c4c54a113"
},
"downloads": -1,
"filename": "xtr-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29a894436840b431ede01c4a5df74649",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15632,
"upload_time": "2023-11-01T14:03:47",
"upload_time_iso_8601": "2023-11-01T14:03:47.096585Z",
"url": "https://files.pythonhosted.org/packages/5b/56/caeedf8950e60685a5b523023b463d65ee655e3f3466aa6ffc5b67a2664c/xtr-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0d92bde6df056ce67131e01d750a6d3acc2d19b192d67307319cdeda963f9e8",
"md5": "9aa9aa4977d83091de19372ac5be8a96",
"sha256": "393ade902b49b753d1fcf41ddf6ba9fb9086dd4018434702c917946a04b68a5e"
},
"downloads": -1,
"filename": "xtr-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "9aa9aa4977d83091de19372ac5be8a96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13472,
"upload_time": "2023-11-01T14:03:48",
"upload_time_iso_8601": "2023-11-01T14:03:48.290339Z",
"url": "https://files.pythonhosted.org/packages/a0/d9/2bde6df056ce67131e01d750a6d3acc2d19b192d67307319cdeda963f9e8/xtr-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 14:03:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "xtr",
"github_not_found": true,
"lcname": "xtr"
}
JSON
