# zipr
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use [`zipr`](https://dsm-72.github.io/zipr/core.html#zipr)
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n zipr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install zipr
```
### nbdev
``` sh
# activate conda environment
$ conda activate zipr
# make sure the zipr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the zipr 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/zipr):
``` sh
$ pip install git+https://github.com/dsm-72/zipr.git
```
or from [conda](https://anaconda.org/dsm-72/zipr)
``` sh
$ conda install -c dsm-72 zipr
```
or from [pypi](https://pypi.org/project/zipr/)
``` sh
$ pip install zipr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/zipr)
[pages](https://dsm-72.github.io/zipr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/zipr) and
[pypi](https://pypi.org/project/zipr/) respectively.
### A = Alias
### C = ClassVar
### Q = Optional
### E = (Over)-Engineered
### Z = Custom
### R = Rich
### P = Plot
### D = Data
### B = Bio
### M = Machine Learning
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/zipr",
"name": "zipr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "zipr mount load package library mounter loader inspect import importlib pkg module",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/34/3c/9610bd4ee92cc6990a6a15a2e2431d51f7448d0fc667466a5777991b2a03/zipr-0.0.2.tar.gz",
"platform": null,
"description": "# zipr\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use [`zipr`](https://dsm-72.github.io/zipr/core.html#zipr)\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 zipr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install zipr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate zipr\n\n# make sure the zipr 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 zipr 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/zipr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/zipr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/zipr)\n\n``` sh\n$ conda install -c dsm-72 zipr\n```\n\nor from [pypi](https://pypi.org/project/zipr/)\n\n``` sh\n$ pip install zipr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/zipr)\n[pages](https://dsm-72.github.io/zipr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/zipr) and\n[pypi](https://pypi.org/project/zipr/) respectively.\n\n### A = Alias\n\n### C = ClassVar\n\n### Q = Optional\n\n### E = (Over)-Engineered\n\n### Z = Custom\n\n### R = Rich\n\n### P = Plot\n\n### D = Data\n\n### B = Bio\n\n### M = Machine Learning\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "zipr",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/zipr"
},
"split_keywords": [
"zipr",
"mount",
"load",
"package",
"library",
"mounter",
"loader",
"inspect",
"import",
"importlib",
"pkg",
"module"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3ae804b8bdf1a6b5bdceb2d5adf8dcece8fcfa60013b76fb148bff8cae3c7df",
"md5": "82cb00d7917e79e5ba2a1f0f9666a739",
"sha256": "9ecd02fbe651e7c00a443beee41bca5619565d3526bb1943682d6c47974e15f9"
},
"downloads": -1,
"filename": "zipr-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82cb00d7917e79e5ba2a1f0f9666a739",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 22166,
"upload_time": "2024-04-02T17:37:37",
"upload_time_iso_8601": "2024-04-02T17:37:37.927906Z",
"url": "https://files.pythonhosted.org/packages/b3/ae/804b8bdf1a6b5bdceb2d5adf8dcece8fcfa60013b76fb148bff8cae3c7df/zipr-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "343c9610bd4ee92cc6990a6a15a2e2431d51f7448d0fc667466a5777991b2a03",
"md5": "9799b4857cc6397187c691d519e7507c",
"sha256": "c7cec2bfd890b1788e9716b6ead3b9f44261b2de85b5226bbe1898a76336e020"
},
"downloads": -1,
"filename": "zipr-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9799b4857cc6397187c691d519e7507c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 23595,
"upload_time": "2024-04-02T17:37:39",
"upload_time_iso_8601": "2024-04-02T17:37:39.541895Z",
"url": "https://files.pythonhosted.org/packages/34/3c/9610bd4ee92cc6990a6a15a2e2431d51f7448d0fc667466a5777991b2a03/zipr-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 17:37:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "zipr",
"github_not_found": true,
"lcname": "zipr"
}
JSON
