# sint
<!-- 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 sint --file env.yml
# $ mamba env update -n sint --file env.mac.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install sint
```
### nbdev
``` sh
# activate conda environment
$ conda activate sint
# make sure the sint package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the sint package
$ nbdev_prepare
```
Note: it might be useful to use the following snippet to enable hot
reloading:
``` python
%load_ext autoreload
%autoreload 2
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/sint):
``` sh
$ pip install git+https://github.com/dsm-72/sint.git
```
or from [conda](https://anaconda.org/dsm-72/sint)
``` sh
$ conda install -c dsm-72 sint
```
or from [pypi](https://pypi.org/project/sint/)
``` sh
$ pip install sint
```
## Examples
``` python
sign.P, sign.Z, sign.N
```
(sign(int=1, chr='P', sym='+', syn={'positive', '+', 'pos'}),
sign(int=0, chr='', sym='', syn=set()),
sign(int=-1, chr='N', sym='-', syn={'negative', 'neg', '-'}))
``` python
sint(2), sint(0), sint(-2), sint('2'), sint('0'), sint('-2'), sint('+'), sint('0'), sint('-')
```
(1, 0, -1, 1, 0, -1, 1, 0, -1)
``` python
sint(2).chr, sint(2).sym, sint(0).chr, sint(0).sym, sint.tochr(2)
```
('P', '+', '', '', 'P')
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/sint",
"name": "sint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "python int sint signal sign intger str num number",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/74/42/c97f540655673444211478694b34a0e6b924d35ec4a883bbba07a5c288c3/sint-0.0.10.tar.gz",
"platform": null,
"description": "# sint\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 sint --file env.yml\n# $ mamba env update -n sint --file env.mac.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install sint\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate sint\n\n# make sure the sint 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 sint package\n$ nbdev_prepare\n```\n\nNote: it might be useful to use the following snippet to enable hot\nreloading:\n\n``` python\n%load_ext autoreload\n%autoreload 2\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```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/sint):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/sint.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/sint)\n\n``` sh\n$ conda install -c dsm-72 sint\n```\n\nor from [pypi](https://pypi.org/project/sint/)\n\n``` sh\n$ pip install sint\n```\n\n## Examples\n\n``` python\nsign.P, sign.Z, sign.N\n```\n\n (sign(int=1, chr='P', sym='+', syn={'positive', '+', 'pos'}),\n sign(int=0, chr='', sym='', syn=set()),\n sign(int=-1, chr='N', sym='-', syn={'negative', 'neg', '-'}))\n\n``` python\nsint(2), sint(0), sint(-2), sint('2'), sint('0'), sint('-2'), sint('+'), sint('0'), sint('-')\n```\n\n (1, 0, -1, 1, 0, -1, 1, 0, -1)\n\n``` python\nsint(2).chr, sint(2).sym, sint(0).chr, sint(0).sym, sint.tochr(2)\n```\n\n ('P', '+', '', '', 'P')\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "si type metric",
"version": "0.0.10",
"project_urls": {
"Homepage": "https://github.com/dsm-72/sint"
},
"split_keywords": [
"python",
"int",
"sint",
"signal",
"sign",
"intger",
"str",
"num",
"number"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0235cd2755c09a87138b13f3dc1c6823b840b351fcd5ed616d85a01bf8e3ece2",
"md5": "0732f43b87e8f06078a7c440f9f3e5a4",
"sha256": "f2ad984cc9a3a29530506cff3e23a4840815b28d61adaa2e0c4a22202d32ceb7"
},
"downloads": -1,
"filename": "sint-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0732f43b87e8f06078a7c440f9f3e5a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 15366,
"upload_time": "2023-12-07T15:23:23",
"upload_time_iso_8601": "2023-12-07T15:23:23.131781Z",
"url": "https://files.pythonhosted.org/packages/02/35/cd2755c09a87138b13f3dc1c6823b840b351fcd5ed616d85a01bf8e3ece2/sint-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7442c97f540655673444211478694b34a0e6b924d35ec4a883bbba07a5c288c3",
"md5": "661338c795c112e0c921ddfb65dc62ae",
"sha256": "26dfb69530fbe7e19a36e7fb5d07d05a3ef104c901e16525108fa2a001a43bfd"
},
"downloads": -1,
"filename": "sint-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "661338c795c112e0c921ddfb65dc62ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 14243,
"upload_time": "2023-12-07T15:23:24",
"upload_time_iso_8601": "2023-12-07T15:23:24.271925Z",
"url": "https://files.pythonhosted.org/packages/74/42/c97f540655673444211478694b34a0e6b924d35ec4a883bbba07a5c288c3/sint-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 15:23:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "sint",
"github_not_found": true,
"lcname": "sint"
}
JSON
