# jstr
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `jstr`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n jstr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install jstr
```
### nbdev
``` sh
# activate conda environment
$ conda activate jstr
# make sure the jstr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the jstr 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/jstr):
``` sh
$ pip install git+https://github.com/dsm-72/jstr.git
```
or from [conda](https://anaconda.org/dsm-72/jstr)
``` sh
$ conda install -c dsm-72 jstr
```
or from [pypi](https://pypi.org/project/jstr/)
``` sh
$ pip install jstr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/jstr)
[pages](https://dsm-72.github.io/jstr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/jstr) and
[pypi](https://pypi.org/project/jstr/) 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/jstr",
"name": "jstr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "j str jstr join just strings dash dot underscore vargs",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/25/96/ebdbc06ea01b64b15a1b07b26eb5cb467a942ca71e7bcfb0fcae76d8d81c/jstr-0.0.4.tar.gz",
"platform": null,
"description": "# jstr\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `jstr`\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 jstr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install jstr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate jstr\n\n# make sure the jstr 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 jstr 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/jstr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/jstr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/jstr)\n\n``` sh\n$ conda install -c dsm-72 jstr\n```\n\nor from [pypi](https://pypi.org/project/jstr/)\n\n``` sh\n$ pip install jstr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/jstr)\n[pages](https://dsm-72.github.io/jstr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/jstr) and\n[pypi](https://pypi.org/project/jstr/) 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": "jstr (join / just strings)",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/dsm-72/jstr"
},
"split_keywords": [
"j",
"str",
"jstr",
"join",
"just",
"strings",
"dash",
"dot",
"underscore",
"vargs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea8ef916af70e65d7afb899b4bcde006e185c50c838906d39f65e34ef446ee07",
"md5": "dff7e3d4228a4bdaefe996252029a89b",
"sha256": "8a54a10cf030bc855d331690a533f874941b912f9a4b615b7942f506e61ee054"
},
"downloads": -1,
"filename": "jstr-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dff7e3d4228a4bdaefe996252029a89b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9330,
"upload_time": "2024-02-25T14:23:03",
"upload_time_iso_8601": "2024-02-25T14:23:03.203936Z",
"url": "https://files.pythonhosted.org/packages/ea/8e/f916af70e65d7afb899b4bcde006e185c50c838906d39f65e34ef446ee07/jstr-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2596ebdbc06ea01b64b15a1b07b26eb5cb467a942ca71e7bcfb0fcae76d8d81c",
"md5": "85f0d36d2b4f7124cfec1ba99258fed0",
"sha256": "20a6e92faed363a5d5038bc7bf441052fa6cd5352ac21c44a94ed91b04d30b82"
},
"downloads": -1,
"filename": "jstr-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "85f0d36d2b4f7124cfec1ba99258fed0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9674,
"upload_time": "2024-02-25T14:23:04",
"upload_time_iso_8601": "2024-02-25T14:23:04.277194Z",
"url": "https://files.pythonhosted.org/packages/25/96/ebdbc06ea01b64b15a1b07b26eb5cb467a942ca71e7bcfb0fcae76d8d81c/jstr-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-25 14:23:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "jstr",
"github_not_found": true,
"lcname": "jstr"
}
JSON
