# aprep
<!-- 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 aprep --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install aprep
```
### nbdev
``` sh
# activate conda environment
$ conda activate aprep
# make sure the aprep package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the aprep 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/aprep):
``` sh
$ pip install git+https://github.com/dsm-72/aprep.git
```
or from [conda](https://anaconda.org/dsm-72/aprep)
``` sh
$ conda install -c dsm-72 aprep
```
or from [pypi](https://pypi.org/project/aprep/)
``` sh
$ pip install aprep
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/aprep)
[pages](https://dsm-72.github.io/aprep/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/aprep) and
[pypi](https://pypi.org/project/aprep/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/aprep",
"name": "aprep",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python attr prep attributes preparation data science args aprep ispec ropts ranked arguments kws",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/5d/05/09f40f75c88f3df6d78bbccfd87c272d2ea1762f2b2b91229954c6d78704/aprep-0.0.3.tar.gz",
"platform": null,
"description": "# aprep\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 aprep --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install aprep\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate aprep\n\n# make sure the aprep 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 aprep 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/aprep):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/aprep.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/aprep)\n\n``` sh\n$ conda install -c dsm-72 aprep\n```\n\nor from [pypi](https://pypi.org/project/aprep/)\n\n``` sh\n$ pip install aprep\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/aprep)\n[pages](https://dsm-72.github.io/aprep/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/aprep) and\n[pypi](https://pypi.org/project/aprep/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "aprep",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dsm-72/aprep"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"attr",
"prep",
"attributes",
"preparation",
"data",
"science",
"args",
"aprep",
"ispec",
"ropts",
"ranked",
"arguments",
"kws"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4f8f1b605bdb3af5b8e933eff89e300d55790aba863e2a0253d0997cf457f61",
"md5": "a62525cc1058ef005566455b3022eb02",
"sha256": "43f67a8292bbedceb8b602097d26bd4e43d87879c5b36b46ec1dc564f38007f8"
},
"downloads": -1,
"filename": "aprep-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a62525cc1058ef005566455b3022eb02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8286,
"upload_time": "2023-09-09T20:16:57",
"upload_time_iso_8601": "2023-09-09T20:16:57.538710Z",
"url": "https://files.pythonhosted.org/packages/d4/f8/f1b605bdb3af5b8e933eff89e300d55790aba863e2a0253d0997cf457f61/aprep-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d0509f40f75c88f3df6d78bbccfd87c272d2ea1762f2b2b91229954c6d78704",
"md5": "510872df6f8a7edb13eb8717ef80b236",
"sha256": "b055da4f6cec5f2f4603b71155dcc40f20eb817497aa4465b04b3fd68e095023"
},
"downloads": -1,
"filename": "aprep-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "510872df6f8a7edb13eb8717ef80b236",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8925,
"upload_time": "2023-09-09T20:16:59",
"upload_time_iso_8601": "2023-09-09T20:16:59.299453Z",
"url": "https://files.pythonhosted.org/packages/5d/05/09f40f75c88f3df6d78bbccfd87c272d2ea1762f2b2b91229954c6d78704/aprep-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-09 20:16:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "aprep",
"github_not_found": true,
"lcname": "aprep"
}
JSON
