# okws
<!-- 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 okws --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install okws
```
### nbdev
``` sh
# activate conda environment
$ conda activate okws
# make sure the okws package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the okws 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/okws):
``` sh
$ pip install git+https://github.com/dsm-72/okws.git
```
or from [conda](https://anaconda.org/dsm-72/okws)
``` sh
$ conda install -c dsm-72 okws
```
or from [pypi](https://pypi.org/project/okws/)
``` sh
$ pip install okws
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/okws)
[pages](https://dsm-72.github.io/okws/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/okws) and
[pypi](https://pypi.org/project/okws/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/okws",
"name": "okws",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "okws overload keywords ol kw keyword kws",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ff/05/7d4940c30b41dac02e185e2fe3ac601b0dce81bc423156739b6e4d154302/okws-0.0.1.tar.gz",
"platform": null,
"description": "# okws\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 okws --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install okws\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate okws\n\n# make sure the okws 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 okws 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/okws):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/okws.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/okws)\n\n``` sh\n$ conda install -c dsm-72 okws\n```\n\nor from [pypi](https://pypi.org/project/okws/)\n\n``` sh\n$ pip install okws\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/okws)\n[pages](https://dsm-72.github.io/okws/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/okws) and\n[pypi](https://pypi.org/project/okws/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "okws",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/okws"
},
"split_keywords": [
"okws",
"overload",
"keywords",
"ol",
"kw",
"keyword",
"kws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06dc4784882e3f5559604093ca04b978637449a2f1a3dbfdb79f753fbacbeac6",
"md5": "26dc0dcba41a3b0ed113eb0f748b492d",
"sha256": "2ef162d7f758b3f0176e288d8cff0376e5f2e92f46b0377abdf62270280f05d8"
},
"downloads": -1,
"filename": "okws-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26dc0dcba41a3b0ed113eb0f748b492d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10292,
"upload_time": "2024-02-27T14:52:08",
"upload_time_iso_8601": "2024-02-27T14:52:08.355357Z",
"url": "https://files.pythonhosted.org/packages/06/dc/4784882e3f5559604093ca04b978637449a2f1a3dbfdb79f753fbacbeac6/okws-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff057d4940c30b41dac02e185e2fe3ac601b0dce81bc423156739b6e4d154302",
"md5": "5b41e28b59cef3fb6bc84a05ba22c555",
"sha256": "7f064ee20c1c9fc7cf207022a8d64610d2360c57b41e95a93a3bb7634d1f9e89"
},
"downloads": -1,
"filename": "okws-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5b41e28b59cef3fb6bc84a05ba22c555",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10801,
"upload_time": "2024-02-27T14:52:27",
"upload_time_iso_8601": "2024-02-27T14:52:27.900757Z",
"url": "https://files.pythonhosted.org/packages/ff/05/7d4940c30b41dac02e185e2fe3ac601b0dce81bc423156739b6e4d154302/okws-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-27 14:52:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "okws",
"github_not_found": true,
"lcname": "okws"
}
JSON
