# astr
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `astr`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n astr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install astr
```
### nbdev
``` sh
# activate conda environment
$ conda activate astr
# make sure the astr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the astr 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/astr):
``` sh
$ pip install git+https://github.com/dsm-72/astr.git
```
or from [conda](https://anaconda.org/dsm-72/astr)
``` sh
$ conda install -c dsm-72 astr
```
or from [pypi](https://pypi.org/project/astr/)
``` sh
$ pip install astr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/astr)
[pages](https://dsm-72.github.io/astr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/astr) and
[pypi](https://pypi.org/project/astr/) respectively.
### A = Alias
### C = ClassVar
### Q = Optional
### E = (Over)-Engineered
### Z = Custom
### R = Rich
### P = Plot
### D = Data
### B = Bio
### M = Machine Learning
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/astr",
"name": "astr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "attr str attribute string astr attrstr python alias type astr typ get set instance ins insattr getter setter",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ad/b7/3624995215275cb4e5f4c4254710365c0b6f49434e7d249c584d68ce7143/astr-0.0.11.tar.gz",
"platform": null,
"description": "# astr\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `astr`\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 astr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install astr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate astr\n\n# make sure the astr 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 astr 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/astr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/astr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/astr)\n\n``` sh\n$ conda install -c dsm-72 astr\n```\n\nor from [pypi](https://pypi.org/project/astr/)\n\n``` sh\n$ pip install astr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/astr)\n[pages](https://dsm-72.github.io/astr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/astr) and\n[pypi](https://pypi.org/project/astr/) respectively.\n\n### A = Alias\n\n### C = ClassVar\n\n### Q = Optional\n\n### E = (Over)-Engineered\n\n### Z = Custom\n\n### R = Rich\n\n### P = Plot\n\n### D = Data\n\n### B = Bio\n\n### M = Machine Learning\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "astr (attribute string) for defined getter / setter methods",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/dsm-72/astr"
},
"split_keywords": [
"attr",
"str",
"attribute",
"string",
"astr",
"attrstr",
"python",
"alias",
"type",
"astr",
"typ",
"get",
"set",
"instance",
"ins",
"insattr",
"getter",
"setter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88e7ee105288563d1aea2905b8c5e04a49e97976685b12f2c54bf3ac33408788",
"md5": "67c17e611a2ac56465a748fc22cfc0f2",
"sha256": "12da2e2788a914949458ecba0a7c551af84fd35a52ba4abf5d7f688baacb77d8"
},
"downloads": -1,
"filename": "astr-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67c17e611a2ac56465a748fc22cfc0f2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14115,
"upload_time": "2024-04-05T15:27:24",
"upload_time_iso_8601": "2024-04-05T15:27:24.862282Z",
"url": "https://files.pythonhosted.org/packages/88/e7/ee105288563d1aea2905b8c5e04a49e97976685b12f2c54bf3ac33408788/astr-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "adb73624995215275cb4e5f4c4254710365c0b6f49434e7d249c584d68ce7143",
"md5": "d941ff4842b65e3462e72844d9629ff6",
"sha256": "ec62a500d3adcc3aaaef441057cd5b8ea4d99d12904eb8bd77c94e99189c34fd"
},
"downloads": -1,
"filename": "astr-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "d941ff4842b65e3462e72844d9629ff6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15453,
"upload_time": "2024-04-05T15:27:26",
"upload_time_iso_8601": "2024-04-05T15:27:26.423032Z",
"url": "https://files.pythonhosted.org/packages/ad/b7/3624995215275cb4e5f4c4254710365c0b6f49434e7d249c584d68ce7143/astr-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 15:27:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "astr",
"github_not_found": true,
"lcname": "astr"
}
JSON
