Metadata-Version: 2.1
Name: achn
Version: 0.0.3
Summary: achn: package for attribute-like chained function calls
Home-page: https://github.com/dsm-72/achn
Author: dsm-72
Author-email: sumner.magruder@yale.edu
License: Apache Software License 2.0
Keywords: achn chachn
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: atyp
Requires-Dist: nchr
Requires-Dist: nlit
Requires-Dist: chck
Requires-Dist: idfunc
Requires-Dist: atup
Requires-Dist: mstar
Provides-Extra: dev

# achn

<!-- 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 bnx --file env.yml
```

### Install

``` sh
pip install -e .

# install from pypi
pip install bnx
```

### nbdev

``` sh
# activate conda environment
$ conda activate bnx

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

# make changes under nbs/ directory
# ...

# compile to have changes apply to the bnx 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/bnx):

``` sh
$ pip install git+https://github.com/dsm-72/bnx.git
```

or from [conda](https://anaconda.org/dsm-72/bnx)

``` sh
$ conda install -c dsm-72 bnx
```

or from [pypi](https://pypi.org/project/bnx/)

``` sh
$ pip install bnx
```

## Documentation

Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/bnx)
[pages](https://dsm-72.github.io/bnx/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/bnx) and
[pypi](https://pypi.org/project/bnx/) respectively.
