GitLocker: The Coding Marketplace

Description:

akey 0.0.5

akey

Developer Guide
Setup
# create conda environment
$ mamba env create -f env.yml

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

Install
pip install -e .

# install from pypi
pip install akey

nbdev
# activate conda environment
$ conda activate akey

# make sure the akey package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to the akey 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/akey.git

or from conda
$ conda install -c dsm-72 akey

or from pypi
$ pip install akey

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