# mstar
<!-- 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 mstar --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install mstar
```
### nbdev
``` sh
# activate conda environment
$ conda activate mstar
# make sure the mstar package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the mstar 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/mstar):
``` sh
$ pip install git+https://github.com/dsm-72/mstar.git
```
or from [conda](https://anaconda.org/dsm-72/mstar)
``` sh
$ conda install -c dsm-72 mstar
```
or from [pypi](https://pypi.org/project/mstar/)
``` sh
$ pip install mstar
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/mstar)
[pages](https://dsm-72.github.io/mstar/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/mstar) and
[pypi](https://pypi.org/project/mstar/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/mstar",
"name": "mstar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "mstar star mod ast asterick",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/4f/a5/2d14c4f7053150135467676e5c0ecb84143565609b38fee518c1d17f631a/mstar-0.0.4.tar.gz",
"platform": null,
"description": "# mstar\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 mstar --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install mstar\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate mstar\n\n# make sure the mstar 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 mstar 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/mstar):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/mstar.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/mstar)\n\n``` sh\n$ conda install -c dsm-72 mstar\n```\n\nor from [pypi](https://pypi.org/project/mstar/)\n\n``` sh\n$ pip install mstar\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/mstar)\n[pages](https://dsm-72.github.io/mstar/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/mstar) and\n[pypi](https://pypi.org/project/mstar/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "mstar",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/dsm-72/mstar"
},
"split_keywords": [
"mstar",
"star",
"mod",
"ast",
"asterick"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89a41b59de7e4286f0a62a9e37dc66aa64209ae7b8a27d4ac8029ebc297736b1",
"md5": "9d00bc2eb253598cec1a4d8600c788fd",
"sha256": "21890f25076535a7abbca5622a1085475bbede58a238bfb6e1a604e863510489"
},
"downloads": -1,
"filename": "mstar-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d00bc2eb253598cec1a4d8600c788fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8067,
"upload_time": "2023-11-13T14:38:22",
"upload_time_iso_8601": "2023-11-13T14:38:22.682483Z",
"url": "https://files.pythonhosted.org/packages/89/a4/1b59de7e4286f0a62a9e37dc66aa64209ae7b8a27d4ac8029ebc297736b1/mstar-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4fa52d14c4f7053150135467676e5c0ecb84143565609b38fee518c1d17f631a",
"md5": "c57bd23b8e4bffbbf03004870c0a4c9d",
"sha256": "ad1a8e069ffc8fa8fad51871a4769c523afe63e23abb3139e43892e386dfe1bb"
},
"downloads": -1,
"filename": "mstar-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c57bd23b8e4bffbbf03004870c0a4c9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8636,
"upload_time": "2023-11-13T14:38:23",
"upload_time_iso_8601": "2023-11-13T14:38:23.724786Z",
"url": "https://files.pythonhosted.org/packages/4f/a5/2d14c4f7053150135467676e5c0ecb84143565609b38fee518c1d17f631a/mstar-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 14:38:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "mstar",
"github_not_found": true,
"lcname": "mstar"
}
JSON
