# uscr
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `uscr`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n uscr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install uscr
```
### nbdev
``` sh
# activate conda environment
$ conda activate uscr
# make sure the uscr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the uscr 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/uscr):
``` sh
$ pip install git+https://github.com/dsm-72/uscr.git
```
or from [conda](https://anaconda.org/dsm-72/uscr)
``` sh
$ conda install -c dsm-72 uscr
```
or from [pypi](https://pypi.org/project/uscr/)
``` sh
$ pip install uscr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/uscr)
[pages](https://dsm-72.github.io/uscr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/uscr) and
[pypi](https://pypi.org/project/uscr/) respectively.
### A = Alias
### C = ClassVar
### Q = Optional
### E = (Over)-Engineered
### Z = Custom
### R = Rich
### P = Plot
### D = Data
### B = Bio
### M = Machine Learning
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/uscr",
"name": "uscr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "uscr underscore dunder sunder mangled private string template class",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/92/ab/bb61a9e84dbe1a0558beba4e1f62acc1fab6b257438e4212604b24c6fa5e/uscr-0.0.2.tar.gz",
"platform": null,
"description": "# uscr\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `uscr`\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 uscr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install uscr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate uscr\n\n# make sure the uscr 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 uscr 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/uscr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/uscr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/uscr)\n\n``` sh\n$ conda install -c dsm-72 uscr\n```\n\nor from [pypi](https://pypi.org/project/uscr/)\n\n``` sh\n$ pip install uscr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/uscr)\n[pages](https://dsm-72.github.io/uscr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/uscr) and\n[pypi](https://pypi.org/project/uscr/) respectively.\n\n### A = Alias\n\n### C = ClassVar\n\n### Q = Optional\n\n### E = (Over)-Engineered\n\n### Z = Custom\n\n### R = Rich\n\n### P = Plot\n\n### D = Data\n\n### B = Bio\n\n### M = Machine Learning\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "uscr (underscore string and string template class)",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/uscr"
},
"split_keywords": [
"uscr",
"underscore",
"dunder",
"sunder",
"mangled",
"private",
"string",
"template",
"class"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd2f0731eecbb0f5b6df66ef046363ca4e5554c7f20cfc374ca863aea4d467c5",
"md5": "bbb22c0ddca8255e227d1f401bb70681",
"sha256": "3bdb04af2376cc943f2348073eb69fba3236856fccb636aaccf5049642b8f5b9"
},
"downloads": -1,
"filename": "uscr-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bbb22c0ddca8255e227d1f401bb70681",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10178,
"upload_time": "2024-02-03T20:07:28",
"upload_time_iso_8601": "2024-02-03T20:07:28.071451Z",
"url": "https://files.pythonhosted.org/packages/cd/2f/0731eecbb0f5b6df66ef046363ca4e5554c7f20cfc374ca863aea4d467c5/uscr-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "92abbb61a9e84dbe1a0558beba4e1f62acc1fab6b257438e4212604b24c6fa5e",
"md5": "3105833c7d77071e870a2aec8b38d7b1",
"sha256": "da33bd64f35dc614368272d7ab84e20569ae2b8e25700c68754dfa0d8f36a18a"
},
"downloads": -1,
"filename": "uscr-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3105833c7d77071e870a2aec8b38d7b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 11320,
"upload_time": "2024-02-03T20:07:29",
"upload_time_iso_8601": "2024-02-03T20:07:29.713827Z",
"url": "https://files.pythonhosted.org/packages/92/ab/bb61a9e84dbe1a0558beba4e1f62acc1fab6b257438e4212604b24c6fa5e/uscr-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 20:07:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "uscr",
"github_not_found": true,
"lcname": "uscr"
}
JSON
