brvstr

Developer Guide

Setup

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

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

Install

pip install -e .

# install from pypi
pip install brvstr

nbdev

# activate conda environment
$ conda activate brvstr

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

# make changes under nbs/ directory
# ...

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

or from conda

$ conda install -c dsm-72 brvstr

or from pypi

$ pip install brvstr

Documentation

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

# Example usage
kg_low = brvstr('kilogram', 'kg')
kg_cap = brvstr('Kilogram', 'Kg')
kg_upp = brvstr('KILOGRAM', 'KG')
kg_low, kg_cap, kg_upp

(kilogram (kg), Kilogram (Kg), KILOGRAM (KG))

kg_low == kg_cap == kg_upp

True

no_abrv = brvstr('Kilogram', )
no_abrv == 'kilogram', no_abrv

(True, Kilogram)