# ropts
<!-- 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 ropts --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install ropts
```
### nbdev
``` sh
# activate conda environment
$ conda activate ropts
# make sure the ropts package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the ropts 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/ropts):
``` sh
$ pip install git+https://github.com/dsm-72/ropts.git
```
or from [conda](https://anaconda.org/dsm-72/ropts)
``` sh
$ conda install -c dsm-72 ropts
```
or from [pypi](https://pypi.org/project/ropts/)
``` sh
$ pip install ropts
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/ropts)
[pages](https://dsm-72.github.io/ropts/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/ropts) and
[pypi](https://pypi.org/project/ropts/) respectively.
``` python
opts = ['a', 'b', 'c']
vals = dict(a=1, bs=2, c=3)
(
ropts(opts),
(ropts(opts).get(**vals), ropts.getval(opts=opts, **vals), ropts(opts).idx('b'), ),
ropts(opts).rnk('c', **vals),
(ropts(opts).rnk(0, **vals), ropts(opts).rnk(1, **vals), ropts(opts).rnk(2, **vals), ),
)
```
(ropts('a', 'b', 'c'), (1, 1, 1), 3, (1, None, 3))
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/ropts",
"name": "ropts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python options opts rank choice ranked ropts attr prep attributes preparation data science",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/3d/d6/be529c34dbdd23750ffb51dec275806c678b39ade1136c7c948b1080929b/ropts-0.0.4.tar.gz",
"platform": null,
"description": "# ropts\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 ropts --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install ropts\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate ropts\n\n# make sure the ropts 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 ropts 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/ropts):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/ropts.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/ropts)\n\n``` sh\n$ conda install -c dsm-72 ropts\n```\n\nor from [pypi](https://pypi.org/project/ropts/)\n\n``` sh\n$ pip install ropts\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/ropts)\n[pages](https://dsm-72.github.io/ropts/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/ropts) and\n[pypi](https://pypi.org/project/ropts/) respectively.\n\n``` python\nopts = ['a', 'b', 'c']\nvals = dict(a=1, bs=2, c=3)\n(\n ropts(opts),\n (ropts(opts).get(**vals), ropts.getval(opts=opts, **vals), ropts(opts).idx('b'), ),\n ropts(opts).rnk('c', **vals), \n (ropts(opts).rnk(0, **vals), ropts(opts).rnk(1, **vals), ropts(opts).rnk(2, **vals), ),\n)\n```\n\n (ropts('a', 'b', 'c'), (1, 1, 1), 3, (1, None, 3))\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ropts",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ropts"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"options",
"opts",
"rank",
"choice",
"ranked",
"ropts",
"attr",
"prep",
"attributes",
"preparation",
"data",
"science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a36e771b3532eab67aa16264ca3d6ea9ea5d08cfa0f08db98c503d98d3d28355",
"md5": "c7ac103fe6bab61e632906aebcfe677a",
"sha256": "925ea7e2aaf496fab5bc7ebe05b2bc6690d8c3ad1a2f4bc1a5f66940648a0aa8"
},
"downloads": -1,
"filename": "ropts-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7ac103fe6bab61e632906aebcfe677a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8336,
"upload_time": "2024-03-13T17:40:23",
"upload_time_iso_8601": "2024-03-13T17:40:23.369708Z",
"url": "https://files.pythonhosted.org/packages/a3/6e/771b3532eab67aa16264ca3d6ea9ea5d08cfa0f08db98c503d98d3d28355/ropts-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dd6be529c34dbdd23750ffb51dec275806c678b39ade1136c7c948b1080929b",
"md5": "cb0b2209ac624569b24c1041df251567",
"sha256": "8cc0224700eee8ee9396528c943bd1d3d8b948114c4b898f27c810a75c845c8b"
},
"downloads": -1,
"filename": "ropts-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "cb0b2209ac624569b24c1041df251567",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8987,
"upload_time": "2024-03-13T17:40:24",
"upload_time_iso_8601": "2024-03-13T17:40:24.394412Z",
"url": "https://files.pythonhosted.org/packages/3d/d6/be529c34dbdd23750ffb51dec275806c678b39ade1136c7c948b1080929b/ropts-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 17:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ropts",
"github_not_found": true,
"lcname": "ropts"
}
JSON
