# pttn
<!-- 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 pttn --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install pttn
```
### nbdev
``` sh
# activate conda environment
$ conda activate pttn
# make sure the pttn package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the pttn 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/pttn):
``` sh
$ pip install git+https://github.com/dsm-72/pttn.git
```
or from [conda](https://anaconda.org/dsm-72/pttn)
``` sh
$ conda install -c dsm-72 pttn
```
or from [pypi](https://pypi.org/project/pttn/)
``` sh
$ pip install pttn
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/pttn)
[pages](https://dsm-72.github.io/pttn/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/pttn) and
[pypi](https://pypi.org/project/pttn/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/pttn",
"name": "pttn",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/8a/59/3e063b46b1a2c68423d76876bb8da5a6f84730289b64dac660b3b8aec27f/pttn-0.0.7.tar.gz",
"platform": null,
"description": "# pttn\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 pttn --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install pttn\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate pttn\n\n# make sure the pttn 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 pttn 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/pttn):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/pttn.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/pttn)\n\n``` sh\n$ conda install -c dsm-72 pttn\n```\n\nor from [pypi](https://pypi.org/project/pttn/)\n\n``` sh\n$ pip install pttn\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/pttn)\n[pages](https://dsm-72.github.io/pttn/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/pttn) and\n[pypi](https://pypi.org/project/pttn/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "chaos package of utilities; a nod to pttnlith",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/dsm-72/pttn"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1835bfaadbae47330e179018823780b8dcdd5742e90c123d293b97afeab6311a",
"md5": "17b8cc34b554ae56fac59774c753a1fa",
"sha256": "57bad24f187113394bd269fa115d23b2c2e5cb3a2a72271990fd60f422573803"
},
"downloads": -1,
"filename": "pttn-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17b8cc34b554ae56fac59774c753a1fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9059,
"upload_time": "2023-11-13T14:36:42",
"upload_time_iso_8601": "2023-11-13T14:36:42.782246Z",
"url": "https://files.pythonhosted.org/packages/18/35/bfaadbae47330e179018823780b8dcdd5742e90c123d293b97afeab6311a/pttn-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a593e063b46b1a2c68423d76876bb8da5a6f84730289b64dac660b3b8aec27f",
"md5": "f1b3c23304b7cae0db4b4cb9c44ba71e",
"sha256": "3b3bfa27a4d34239fb8c2da8a1cac6cf73777f131f74370ef22be969d0629596"
},
"downloads": -1,
"filename": "pttn-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "f1b3c23304b7cae0db4b4cb9c44ba71e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 9161,
"upload_time": "2023-11-13T14:36:44",
"upload_time_iso_8601": "2023-11-13T14:36:44.203525Z",
"url": "https://files.pythonhosted.org/packages/8a/59/3e063b46b1a2c68423d76876bb8da5a6f84730289b64dac660b3b8aec27f/pttn-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 14:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "pttn",
"github_not_found": true,
"lcname": "pttn"
}
JSON
