# xath
<!-- 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 xath --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install xath
```
### nbdev
``` sh
# activate conda environment
$ conda activate xath
# make sure the xath package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the xath 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/xath):
``` sh
$ pip install git+https://github.com/dsm-72/xath.git
```
or from [conda](https://anaconda.org/dsm-72/xath)
``` sh
$ conda install -c dsm-72 xath
```
or from [pypi](https://pypi.org/project/xath/)
``` sh
$ pip install xath
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/xath)
[pages](https://dsm-72.github.io/xath/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/xath) and
[pypi](https://pypi.org/project/xath/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/xath",
"name": "xath",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/9e/88/c0b2d05f3a48e657c49715e7f984624e2967087838a6bcb9692217cbe4a3/xath-0.0.6.tar.gz",
"platform": null,
"description": "# xath\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 xath --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install xath\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate xath\n\n# make sure the xath 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 xath 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/xath):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/xath.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/xath)\n\n``` sh\n$ conda install -c dsm-72 xath\n```\n\nor from [pypi](https://pypi.org/project/xath/)\n\n``` sh\n$ pip install xath\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/xath)\n[pages](https://dsm-72.github.io/xath/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/xath) and\n[pypi](https://pypi.org/project/xath/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "structured directories",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/dsm-72/xath"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56dcae311b95ced10cfc3538f760d411082bb36458820b9e2c9cbad9a8d7877b",
"md5": "50938a582afecf6b306e1d4b82b6cd68",
"sha256": "b92234739b2bdc6e52080da7efa276dd3431259527b81168f7b2ce0b681ab8f4"
},
"downloads": -1,
"filename": "xath-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50938a582afecf6b306e1d4b82b6cd68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 49478,
"upload_time": "2023-11-12T20:39:19",
"upload_time_iso_8601": "2023-11-12T20:39:19.535369Z",
"url": "https://files.pythonhosted.org/packages/56/dc/ae311b95ced10cfc3538f760d411082bb36458820b9e2c9cbad9a8d7877b/xath-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e88c0b2d05f3a48e657c49715e7f984624e2967087838a6bcb9692217cbe4a3",
"md5": "aa1156beb3febbfd46068dae5fc5e00d",
"sha256": "04a1b3bcdbad80c4e86561308e7e9468426e87a325d67f53c4dabcb931b9eb5f"
},
"downloads": -1,
"filename": "xath-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "aa1156beb3febbfd46068dae5fc5e00d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 43443,
"upload_time": "2023-11-12T20:39:20",
"upload_time_iso_8601": "2023-11-12T20:39:20.580041Z",
"url": "https://files.pythonhosted.org/packages/9e/88/c0b2d05f3a48e657c49715e7f984624e2967087838a6bcb9692217cbe4a3/xath-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-12 20:39:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "xath",
"github_not_found": true,
"lcname": "xath"
}
JSON
