Skip to main content

zipr

Project description

zipr

Packages that use zipr

Developer Guide

Setup

# create conda environment
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n zipr --file env.yml

Install

pip install -e .

# install from pypi
pip install zipr

nbdev

# 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

# 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:

$ pip install git+https://github.com/dsm-72/zipr.git

or from conda

$ conda install -c dsm-72 zipr

or from pypi

$ pip install zipr

Documentation

Documentation can be found hosted on GitHub repository pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

A = Alias

C = ClassVar

Q = Optional

E = (Over)-Engineered

Z = Custom

R = Rich

P = Plot

D = Data

B = Bio

M = Machine Learning

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page