# brvstr
<!-- 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 brvstr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install brvstr
```
### nbdev
``` sh
# activate conda environment
$ conda activate brvstr
# make sure the brvstr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the brvstr 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/brvstr):
``` sh
$ pip install git+https://github.com/dsm-72/brvstr.git
```
or from [conda](https://anaconda.org/dsm-72/brvstr)
``` sh
$ conda install -c dsm-72 brvstr
```
or from [pypi](https://pypi.org/project/brvstr/)
``` sh
$ pip install brvstr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/brvstr)
[pages](https://dsm-72.github.io/brvstr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/brvstr) and
[pypi](https://pypi.org/project/brvstr/) respectively.
``` python
# Example usage
kg_low = brvstr('kilogram', 'kg')
kg_cap = brvstr('Kilogram', 'Kg')
kg_upp = brvstr('KILOGRAM', 'KG')
kg_low, kg_cap, kg_upp
```
(kilogram (kg), Kilogram (Kg), KILOGRAM (KG))
``` python
kg_low == kg_cap == kg_upp
```
True
``` python
no_abrv = brvstr('Kilogram', )
no_abrv == 'kilogram', no_abrv
```
(True, Kilogram)
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/brvstr",
"name": "brvstr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "abbreviation abbrev abrv brev brevity syn synonyms alias set aliasable canon canonical name things with fuzzy string matching brvstr nym str fuz fuzstr atyp ispec indoc dynattr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/59/c7/e45badd0bbcc145c845c3f571f7cb1246f29591fd9e5c3eac2b26d5e3d32/brvstr-0.0.1.tar.gz",
"platform": null,
"description": "# brvstr\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 brvstr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install brvstr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate brvstr\n\n# make sure the brvstr 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 brvstr 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/brvstr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/brvstr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/brvstr)\n\n``` sh\n$ conda install -c dsm-72 brvstr\n```\n\nor from [pypi](https://pypi.org/project/brvstr/)\n\n``` sh\n$ pip install brvstr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/brvstr)\n[pages](https://dsm-72.github.io/brvstr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/brvstr) and\n[pypi](https://pypi.org/project/brvstr/) respectively.\n\n``` python\n# Example usage\nkg_low = brvstr('kilogram', 'kg')\nkg_cap = brvstr('Kilogram', 'Kg')\nkg_upp = brvstr('KILOGRAM', 'KG')\nkg_low, kg_cap, kg_upp\n```\n\n (kilogram (kg), Kilogram (Kg), KILOGRAM (KG))\n\n``` python\nkg_low == kg_cap == kg_upp\n```\n\n True\n\n``` python\nno_abrv = brvstr('Kilogram', )\nno_abrv == 'kilogram', no_abrv\n```\n\n (True, Kilogram)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "brvstr",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/brvstr"
},
"split_keywords": [
"abbreviation",
"abbrev",
"abrv",
"brev",
"brevity",
"syn",
"synonyms",
"alias",
"set",
"aliasable",
"canon",
"canonical",
"name",
"things",
"with",
"fuzzy",
"string",
"matching",
"brvstr",
"nym",
"str",
"fuz",
"fuzstr",
"atyp",
"ispec",
"indoc",
"dynattr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "314ba2c90b04f5ce23034432be94f875eb8a9964f40c761e16aa29b9e2655e11",
"md5": "8d9cf14c47fb90c4c9c48369d4b3ce1b",
"sha256": "aa8292711de29d0b2c102998eefc355f902db6b515d0f1014f68f510914691d1"
},
"downloads": -1,
"filename": "brvstr-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8d9cf14c47fb90c4c9c48369d4b3ce1b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9678,
"upload_time": "2023-09-10T14:24:37",
"upload_time_iso_8601": "2023-09-10T14:24:37.118341Z",
"url": "https://files.pythonhosted.org/packages/31/4b/a2c90b04f5ce23034432be94f875eb8a9964f40c761e16aa29b9e2655e11/brvstr-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "59c7e45badd0bbcc145c845c3f571f7cb1246f29591fd9e5c3eac2b26d5e3d32",
"md5": "c432f4abaeb6e3523dc9fdae3f628b4e",
"sha256": "7b8d2f6dfe52a9ddf44dcb11e67072e4dafb310e763d42b638609ad2536af2c4"
},
"downloads": -1,
"filename": "brvstr-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c432f4abaeb6e3523dc9fdae3f628b4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10215,
"upload_time": "2023-09-10T14:24:39",
"upload_time_iso_8601": "2023-09-10T14:24:39.013724Z",
"url": "https://files.pythonhosted.org/packages/59/c7/e45badd0bbcc145c845c3f571f7cb1246f29591fd9e5c3eac2b26d5e3d32/brvstr-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-10 14:24:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "brvstr",
"github_not_found": true,
"lcname": "brvstr"
}
JSON
