# binr
<!-- 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 binr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install binr
```
### nbdev
``` sh
# activate conda environment
$ conda activate binr
# make sure the binr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the binr 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/binr):
``` sh
$ pip install git+https://github.com/dsm-72/binr.git
```
or from [conda](https://anaconda.org/dsm-72/binr)
``` sh
$ conda install -c dsm-72 binr
```
or from [pypi](https://pypi.org/project/binr/)
``` sh
$ pip install binr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/binr)
[pages](https://dsm-72.github.io/binr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/binr) and
[pypi](https://pypi.org/project/binr/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/binr",
"name": "binr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "binr bin bins nbins n binner binning bin",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/34/9c/755e7a16a8c2ae18cb651bbb195bc137cd5c02e15a8120a8ad811a5dfd44/binr-0.0.2.tar.gz",
"platform": null,
"description": "# binr\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 binr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install binr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate binr\n\n# make sure the binr 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 binr 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/binr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/binr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/binr)\n\n``` sh\n$ conda install -c dsm-72 binr\n```\n\nor from [pypi](https://pypi.org/project/binr/)\n\n``` sh\n$ pip install binr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/binr)\n[pages](https://dsm-72.github.io/binr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/binr) and\n[pypi](https://pypi.org/project/binr/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "binr",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/binr"
},
"split_keywords": [
"binr",
"bin",
"bins",
"nbins",
"n",
"binner",
"binning",
"bin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c68c07c37e91d9abd5e5c7ecdf13dc23ddfb4aff38f521719ba324e9b7227e8",
"md5": "1e4f1f039888a63b792de11a1ec159eb",
"sha256": "fd2a1953b4b9769cf61809ef982bd8619db67536cb9e2b9b3463f12599833619"
},
"downloads": -1,
"filename": "binr-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e4f1f039888a63b792de11a1ec159eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9940,
"upload_time": "2023-12-17T14:17:45",
"upload_time_iso_8601": "2023-12-17T14:17:45.025396Z",
"url": "https://files.pythonhosted.org/packages/4c/68/c07c37e91d9abd5e5c7ecdf13dc23ddfb4aff38f521719ba324e9b7227e8/binr-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "349c755e7a16a8c2ae18cb651bbb195bc137cd5c02e15a8120a8ad811a5dfd44",
"md5": "fccef5e128e982cccd803ed9f153da9c",
"sha256": "be36d0c8a00a877f7c35f83dccb608442df969bdddeecf26d65a7bf8a03a98b9"
},
"downloads": -1,
"filename": "binr-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fccef5e128e982cccd803ed9f153da9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10485,
"upload_time": "2023-12-17T14:17:46",
"upload_time_iso_8601": "2023-12-17T14:17:46.544843Z",
"url": "https://files.pythonhosted.org/packages/34/9c/755e7a16a8c2ae18cb651bbb195bc137cd5c02e15a8120a8ad811a5dfd44/binr-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 14:17:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "binr",
"github_not_found": true,
"lcname": "binr"
}
JSON
