# putl
<!-- 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 putl --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install putl
```
### nbdev
``` sh
# activate conda environment
$ conda activate putl
# make sure the putl package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the putl 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/putl):
``` sh
$ pip install git+https://github.com/dsm-72/putl.git
```
or from [conda](https://anaconda.org/dsm-72/putl)
``` sh
$ conda install -c dsm-72 putl
```
or from [pypi](https://pypi.org/project/putl/)
``` sh
$ pip install putl
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/putl)
[pages](https://dsm-72.github.io/putl/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/putl) and
[pypi](https://pypi.org/project/putl/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/putl",
"name": "putl",
"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/ad/4f/1748904c830de9afafe5947150e83f86e6d42886df46d97363777782049c/putl-0.0.15.tar.gz",
"platform": null,
"description": "# putl\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 putl --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install putl\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate putl\n\n# make sure the putl 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 putl 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/putl):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/putl.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/putl)\n\n``` sh\n$ conda install -c dsm-72 putl\n```\n\nor from [pypi](https://pypi.org/project/putl/)\n\n``` sh\n$ pip install putl\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/putl)\n[pages](https://dsm-72.github.io/putl/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/putl) and\n[pypi](https://pypi.org/project/putl/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "chaos package of utilities; a nod to putllith",
"version": "0.0.15",
"project_urls": {
"Homepage": "https://github.com/dsm-72/putl"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41d44b1c737edfa3ed4057332a51e8233b8f82c1d913dd49dfa6122d857e3c9e",
"md5": "a2b411982dd33fae2e214fc4a3121afe",
"sha256": "27a30bf7f9defac1d8fc8b2f1fa3f949d7393711c20ff726d71bfc244b0f8c36"
},
"downloads": -1,
"filename": "putl-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2b411982dd33fae2e214fc4a3121afe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14483,
"upload_time": "2023-12-28T20:58:19",
"upload_time_iso_8601": "2023-12-28T20:58:19.848461Z",
"url": "https://files.pythonhosted.org/packages/41/d4/4b1c737edfa3ed4057332a51e8233b8f82c1d913dd49dfa6122d857e3c9e/putl-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ad4f1748904c830de9afafe5947150e83f86e6d42886df46d97363777782049c",
"md5": "dc5c1ebaee2e04d10c17b65106293179",
"sha256": "76c2c188ab15aee3ef744b1d5e95e713a4bf164c9703af94559cea954984d6e0"
},
"downloads": -1,
"filename": "putl-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "dc5c1ebaee2e04d10c17b65106293179",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13487,
"upload_time": "2023-12-28T20:58:21",
"upload_time_iso_8601": "2023-12-28T20:58:21.148372Z",
"url": "https://files.pythonhosted.org/packages/ad/4f/1748904c830de9afafe5947150e83f86e6d42886df46d97363777782049c/putl-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-28 20:58:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "putl",
"github_not_found": true,
"lcname": "putl"
}
JSON
