# aspec
<!-- 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 aspec --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install aspec
```
### nbdev
``` sh
# activate conda environment
$ conda activate aspec
# make sure the aspec package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the aspec 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/aspec):
``` sh
$ pip install git+https://github.com/dsm-72/aspec.git
```
or from [conda](https://anaconda.org/dsm-72/aspec)
``` sh
$ conda install -c dsm-72 aspec
```
or from [pypi](https://pypi.org/project/aspec/)
``` sh
$ pip install aspec
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/aspec)
[pages](https://dsm-72.github.io/aspec/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/aspec) and
[pypi](https://pypi.org/project/aspec/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/aspec",
"name": "aspec",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python attr prep util spec attributes preparation data science args autil atil aspec ispec ropts ranked arguments kws",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/61/41/c55bd4c9e1f4aa18da71b4e3390815c6df36e6c5a34a53a24c2256264bbb/aspec-0.0.16.tar.gz",
"platform": null,
"description": "# aspec\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 aspec --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install aspec\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate aspec\n\n# make sure the aspec 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 aspec 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/aspec):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/aspec.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/aspec)\n\n``` sh\n$ conda install -c dsm-72 aspec\n```\n\nor from [pypi](https://pypi.org/project/aspec/)\n\n``` sh\n$ pip install aspec\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/aspec)\n[pages](https://dsm-72.github.io/aspec/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/aspec) and\n[pypi](https://pypi.org/project/aspec/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "attribute specificatoin (aspec)",
"version": "0.0.16",
"project_urls": {
"Homepage": "https://github.com/dsm-72/aspec"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"attr",
"prep",
"util",
"spec",
"attributes",
"preparation",
"data",
"science",
"args",
"autil",
"atil",
"aspec",
"ispec",
"ropts",
"ranked",
"arguments",
"kws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce2870dc6b599f9fcbfcff76789043a7b041a3b644709a0dba40ce9bbcac496d",
"md5": "7e682461b909c14e3ab9b265f8e3fb90",
"sha256": "919e85451f969d36431103ed89267f2fa1b9e79716d0fb4f690e4c9b291229df"
},
"downloads": -1,
"filename": "aspec-0.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e682461b909c14e3ab9b265f8e3fb90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 16761,
"upload_time": "2024-03-13T17:54:16",
"upload_time_iso_8601": "2024-03-13T17:54:16.137493Z",
"url": "https://files.pythonhosted.org/packages/ce/28/70dc6b599f9fcbfcff76789043a7b041a3b644709a0dba40ce9bbcac496d/aspec-0.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6141c55bd4c9e1f4aa18da71b4e3390815c6df36e6c5a34a53a24c2256264bbb",
"md5": "762d8c63cfe10675d04042599746eaf4",
"sha256": "4af91bd3e1bc7dc8415ddbbf6c0ebd79c00217ba0eb63da4004c78996f300671"
},
"downloads": -1,
"filename": "aspec-0.0.16.tar.gz",
"has_sig": false,
"md5_digest": "762d8c63cfe10675d04042599746eaf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 16983,
"upload_time": "2024-03-13T17:54:17",
"upload_time_iso_8601": "2024-03-13T17:54:17.714620Z",
"url": "https://files.pythonhosted.org/packages/61/41/c55bd4c9e1f4aa18da71b4e3390815c6df36e6c5a34a53a24c2256264bbb/aspec-0.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 17:54:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "aspec",
"github_not_found": true,
"lcname": "aspec"
}
JSON
