# ston
<!-- 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 ston --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install ston
```
### nbdev
``` sh
# activate conda environment
$ conda activate ston
# make sure the ston package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the ston 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/ston):
``` sh
$ pip install git+https://github.com/dsm-72/ston.git
```
or from [conda](https://anaconda.org/dsm-72/ston)
``` sh
$ conda install -c dsm-72 ston
```
or from [pypi](https://pypi.org/project/ston/)
``` sh
$ pip install ston
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/ston)
[pages](https://dsm-72.github.io/ston/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/ston) and
[pypi](https://pypi.org/project/ston/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/ston",
"name": "ston",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "singleton",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ca/86/067fc833b585ec3b2ca366aed152d85325f9de76eb3a7657e8bdc2fdfe0f/ston-0.0.4.tar.gz",
"platform": null,
"description": "# ston\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 ston --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install ston\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate ston\n\n# make sure the ston 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 ston 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/ston):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/ston.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/ston)\n\n``` sh\n$ conda install -c dsm-72 ston\n```\n\nor from [pypi](https://pypi.org/project/ston/)\n\n``` sh\n$ pip install ston\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/ston)\n[pages](https://dsm-72.github.io/ston/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/ston) and\n[pypi](https://pypi.org/project/ston/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ston",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ston"
},
"split_keywords": [
"singleton"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c3faee067fd8e4c56589f1dabfb98b9d6618dec8a83b0501d616f5f6fd438ce",
"md5": "1c0e4a3fb3bff3ad48a795403505dc0c",
"sha256": "700f750ff868ab62059d07f8e8d731b220d0e2ec011f3dfd75e2e9ffeb2e8857"
},
"downloads": -1,
"filename": "ston-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c0e4a3fb3bff3ad48a795403505dc0c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 12798,
"upload_time": "2024-03-06T14:40:04",
"upload_time_iso_8601": "2024-03-06T14:40:04.163299Z",
"url": "https://files.pythonhosted.org/packages/3c/3f/aee067fd8e4c56589f1dabfb98b9d6618dec8a83b0501d616f5f6fd438ce/ston-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca86067fc833b585ec3b2ca366aed152d85325f9de76eb3a7657e8bdc2fdfe0f",
"md5": "c98ce5cfb978ece53ecc636ce2838438",
"sha256": "b5b5f01fbef9e594dc41c1bf1f95e2d76e5ad15bf71c4a13a54492bb2bb562fb"
},
"downloads": -1,
"filename": "ston-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c98ce5cfb978ece53ecc636ce2838438",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13253,
"upload_time": "2024-03-06T14:40:05",
"upload_time_iso_8601": "2024-03-06T14:40:05.360302Z",
"url": "https://files.pythonhosted.org/packages/ca/86/067fc833b585ec3b2ca366aed152d85325f9de76eb3a7657e8bdc2fdfe0f/ston-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 14:40:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ston",
"github_not_found": true,
"lcname": "ston"
}
JSON
