atyp (type alias)
Project description
atyp
Packages that use atyp
aprep
aspec
brvstr
dynattr
fuzstr
ispec
narr
nbkit
nymstr
synstr
Developer Guide
Setup
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n atyp --file env.yml
Install
pip install -e .
# install from pypi
pip install atyp
nbdev
# activate conda environment
$ conda activate atyp
# make sure the atyp package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the atyp 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/atyp.git
or from conda
$ conda install -c dsm-72 atyp
or from pypi
$ pip install atyp
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
# from atyp.atyp import (
# # Booleans
# Boolic, Boolish, Bools,
# # Numbers
# Numeric, Numbers,
# # Strings
# StrLike, Strs, StrSet,
# # Paths
# PathType, PathLike,
# # Enums
# Intum, Strum,
# # Bytes
# ByteLike,
# # Typing
# Literals, TypingLike, GuardLike,
# # Importlib
# Module, Loader, ModuleSpec,
# # Inspect
# Sig, Param,
# )
C = ClassVar
# from atyp.ctyp import (
# ClsInt, ClsStr, ClsBool, ClsFloat
# )
Q = Optional
# from atyp.qtyp import (
# AnyQ, IntQ, SetQ, StrQ, ObjQ,
# BoolQ, CallQ, TypeQ, ListQ, IterQ,
# FloatQ, NumberQ, ComplexQ, StrLikeQ,
# ClsStrQ,
# )
E = (Over)-Engineered
# from atyp.etyp import ()
Z = Custom
# from atyp.ztyp import (FlagFunc, FlagFuncQ)
R = Rich
# from atyp.rtyp import (
# RichTree, RichText, RichCons, RichProg, TyperApp
# )
P = Plot
# from atyp.ptyp import (
# Axes, ColorMap, CBarPos
# )
D = Data
# from atyp.dtyp import (
# NPArray, ndarray,
# Idx, Index, Series,
# DFrame, DataFrame, DataFrames,
# IndexLike, SeriesLike, IterLike,
# GroupKey
# )
B = Bio
# from atyp.btyp import (
# Adata, Adatas, AnnData, AnnDatas
# )
M = Machine Learning
# from atyp.mtyp import (Tensor, Device)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
atyp-0.0.11.tar.gz
(12.7 kB
view hashes)
Built Distribution
atyp-0.0.11-py3-none-any.whl
(13.0 kB
view hashes)