README.ipynb

{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "id": "extreme-evanescence",
   "metadata": {},
   "source": [
    "<a href=\"https://github.com/dynamic-graphics-inc/dgpy-libs\">\n",
    "<img align=\"right\" src=\"https://github.com/dynamic-graphics-inc/dgpy-libs/blob/main/docs/images/dgpy_banner.svg?raw=true\" alt=\"drawing\" height=\"120\" width=\"300\"/>\n",
    "</a>\n",
    "\n",
    "# dgpy-libs\n",
    "\n",
    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dynamic-graphics-inc/dgpy-libs/main?filepath=README.ipynb)\n",
    "[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n",
    "\n",
    "Docs: [dynamic-graphics-inc.github.io/dgpy-libs](https://dynamic-graphics-inc.github.io/dgpy-libs/)\n",
    "\n",
    "Repo: [github.com/dynamic-graphics-inc/dgpy-libs](https://github.com/dynamic-graphics-inc/dgpy-libs)\n",
    "\n",
    "___\n",
    "\n",
    "Dynamic Graphics python libraries, home of:\n",
    "\n",
    " - Callable modules and packages\n",
    " - Recursive list/gen comprehensions\n",
    " - Nutty decorators\n",
    " - Secret agent JSON Bourne\n",
    " - The best package names around\n",
    " - Notebooks with funky python\n",
    " - Dynamic imports\n",
    "\n",
    "## Libs\n",
    "\n",
    "```\n",
    "libs\n",
    "├── aiopen\n",
    "├── asyncify\n",
    "├── dgpylibs\n",
    "├── dgpytest\n",
    "├── fmts\n",
    "├── funkify\n",
    "├── h5\n",
    "├── jsonbourne\n",
    "├── lager\n",
    "├── listless\n",
    "├── requires\n",
    "├── shellfish\n",
    "└── xtyping\n",
    "```\n",
    "\n",
    "**Install:** `pip install aiopen asyncify fmts funkify h5 jsonbourne lager listless requires shellfish xtyping`\n",
    "\n",
    "\n",
    "### [aiopen](./libs/aiopen) ~ `pip install aiopen` ~ [![Wheel](https://img.shields.io/pypi/wheel/aiopen.svg)](https://img.shields.io/pypi/wheel/aiopen.svg) [![Version](https://img.shields.io/pypi/v/aiopen.svg)](https://img.shields.io/pypi/v/aiopen.svg) [![py_versions](https://img.shields.io/pypi/pyversions/aiopen.svg)](https://img.shields.io/pypi/pyversions/aiopen.svg)\n",
    "\n",
    "### [asyncify](./libs/asyncify) ~ `pip install asyncify` ~ [![Wheel](https://img.shields.io/pypi/wheel/asyncify.svg)](https://img.shields.io/pypi/wheel/asyncify.svg) [![Version](https://img.shields.io/pypi/v/asyncify.svg)](https://img.shields.io/pypi/v/asyncify.svg) [![py_versions](https://img.shields.io/pypi/pyversions/asyncify.svg)](https://img.shields.io/pypi/pyversions/asyncify.svg)\n",
    "\n",
    "### [dgpylibs](./libs/dgpylibs) ~ `pip install dgpylibs` ~ [![Wheel](https://img.shields.io/pypi/wheel/dgpylibs.svg)](https://img.shields.io/pypi/wheel/dgpylibs.svg) [![Version](https://img.shields.io/pypi/v/dgpylibs.svg)](https://img.shields.io/pypi/v/dgpylibs.svg) [![py_versions](https://img.shields.io/pypi/pyversions/dgpylibs.svg)](https://img.shields.io/pypi/pyversions/dgpylibs.svg)\n",
    "\n",
    "### [dgpytest](./libs/dgpytest) ~ `pip install dgpytest` ~ [![Wheel](https://img.shields.io/pypi/wheel/dgpytest.svg)](https://img.shields.io/pypi/wheel/dgpytest.svg) [![Version](https://img.shields.io/pypi/v/dgpytest.svg)](https://img.shields.io/pypi/v/dgpytest.svg) [![py_versions](https://img.shields.io/pypi/pyversions/dgpytest.svg)](https://img.shields.io/pypi/pyversions/dgpytest.svg)\n",
    "\n",
    "### [fmts](./libs/fmts) ~ `pip install fmts` ~ [![Wheel](https://img.shields.io/pypi/wheel/fmts.svg)](https://img.shields.io/pypi/wheel/fmts.svg) [![Version](https://img.shields.io/pypi/v/fmts.svg)](https://img.shields.io/pypi/v/fmts.svg) [![py_versions](https://img.shields.io/pypi/pyversions/fmts.svg)](https://img.shields.io/pypi/pyversions/fmts.svg)\n",
    "\n",
    "### [funkify](./libs/funkify) ~ `pip install funkify` ~ [![Wheel](https://img.shields.io/pypi/wheel/funkify.svg)](https://img.shields.io/pypi/wheel/funkify.svg) [![Version](https://img.shields.io/pypi/v/funkify.svg)](https://img.shields.io/pypi/v/funkify.svg) [![py_versions](https://img.shields.io/pypi/pyversions/funkify.svg)](https://img.shields.io/pypi/pyversions/funkify.svg)\n",
    "\n",
    "### [h5](./libs/h5) ~ `pip install h5` ~ [![Wheel](https://img.shields.io/pypi/wheel/h5.svg)](https://img.shields.io/pypi/wheel/h5.svg) [![Version](https://img.shields.io/pypi/v/h5.svg)](https://img.shields.io/pypi/v/h5.svg) [![py_versions](https://img.shields.io/pypi/pyversions/h5.svg)](https://img.shields.io/pypi/pyversions/h5.svg)\n",
    "\n",
    "### [jsonbourne](./libs/jsonbourne) ~ `pip install jsonbourne` ~ [![Wheel](https://img.shields.io/pypi/wheel/jsonbourne.svg)](https://img.shields.io/pypi/wheel/jsonbourne.svg) [![Version](https://img.shields.io/pypi/v/jsonbourne.svg)](https://img.shields.io/pypi/v/jsonbourne.svg) [![py_versions](https://img.shields.io/pypi/pyversions/jsonbourne.svg)](https://img.shields.io/pypi/pyversions/jsonbourne.svg)\n",
    "\n",
    "### [lager](./libs/lager) ~ `pip install lager` ~ [![Wheel](https://img.shields.io/pypi/wheel/lager.svg)](https://img.shields.io/pypi/wheel/lager.svg) [![Version](https://img.shields.io/pypi/v/lager.svg)](https://img.shields.io/pypi/v/lager.svg) [![py_versions](https://img.shields.io/pypi/pyversions/lager.svg)](https://img.shields.io/pypi/pyversions/lager.svg)\n",
    "\n",
    "### [listless](./libs/listless) ~ `pip install listless` ~ [![Wheel](https://img.shields.io/pypi/wheel/listless.svg)](https://img.shields.io/pypi/wheel/listless.svg) [![Version](https://img.shields.io/pypi/v/listless.svg)](https://img.shields.io/pypi/v/listless.svg) [![py_versions](https://img.shields.io/pypi/pyversions/listless.svg)](https://img.shields.io/pypi/pyversions/listless.svg)\n",
    "\n",
    "### [requires](./libs/requires) ~ `pip install requires` ~ [![Wheel](https://img.shields.io/pypi/wheel/requires.svg)](https://img.shields.io/pypi/wheel/requires.svg) [![Version](https://img.shields.io/pypi/v/requires.svg)](https://img.shields.io/pypi/v/requires.svg) [![py_versions](https://img.shields.io/pypi/pyversions/requires.svg)](https://img.shields.io/pypi/pyversions/requires.svg)\n",
    "\n",
    "### [shellfish](./libs/shellfish) ~ `pip install shellfish` ~ [![Wheel](https://img.shields.io/pypi/wheel/shellfish.svg)](https://img.shields.io/pypi/wheel/shellfish.svg) [![Version](https://img.shields.io/pypi/v/shellfish.svg)](https://img.shields.io/pypi/v/shellfish.svg) [![py_versions](https://img.shields.io/pypi/pyversions/shellfish.svg)](https://img.shields.io/pypi/pyversions/shellfish.svg)\n",
    "\n",
    "### [xtyping](./libs/xtyping) ~ `pip install xtyping` ~ [![Wheel](https://img.shields.io/pypi/wheel/xtyping.svg)](https://img.shields.io/pypi/wheel/xtyping.svg) [![Version](https://img.shields.io/pypi/v/xtyping.svg)](https://img.shields.io/pypi/v/xtyping.svg) [![py_versions](https://img.shields.io/pypi/pyversions/xtyping.svg)](https://img.shields.io/pypi/pyversions/xtyping.svg)\n",
    "\n",
    "## About\n",
    "\n",
    "This repo (dgpy-libs) are the polished gems formed under intense pressure below the offices of [Dynamic Graphics Inc](http://dgi.com/). These pure-python libraries are all published on pip under the listed names.\n",
    "\n",
    "### Design PhilosoPY\n",
    "\n",
    " - dgpy-libs must have excellent names and be published on pip\n",
    " - Embrace `async/await`\n",
    " - Python 3.6 'n up, baby! (May move to 3.7 for `__future___.annotations`... tbd)\n",
    " - Use type annotations everywhere\n",
    " - No dead or commented out code\n",
    " - Prefer pure-python & compiled-3rd-party-libs over writing packages with compiled extensions\n",
    " - Use optional compiled-3rd-party-libs as optional dependencies to sneakily speed things up if present\n",
    " - Offer integrations with the super-hot-fire modern python packages all the kids are using\n",
    " - Optional dependencies are good! Missing optional deps should trigger an error msg that is helpful to installing the relevant dependency ONLY IF THE DEPENDENCY IS NEEDED.\n",
    " - Test coverage is usually a dumb metric and 100% test coverate `!=` bug-free code (tests of dgpy-libs are slowly being migrated from internal/private repos to this repo)\n",
    "\n",
    "### Third party friends\n",
    "\n",
    " - [pydantic](https://pydantic-docs.helpmanual.io/); best python lib you will ever use\n",
    " - [loguru](https://github.com/Delgan/loguru); base of lager\n",
    " - [httpx](https://www.python-httpx.org/) ; don't use requests\n",
    " - [attrs](https://github.com/python-attrs/attrs); pydantic alternative\n",
    " - [poetry](https://github.com/python-poetry/poetry); best dep management python has to offer\n",
    " - [orjson](https://github.com/ijl/orjson); fastest python json lib (opt dep of jsonbourne)\n",
    " - [rapidjson/python-rapidjson](https://github.com/python-rapidjson/python-rapidjson); best mostly drop-in replacement for python's json module\n",
    " - [h5py](https://github.com/h5py/h5py); base of h5\n",
    " - [rich](https://github.com/willmcgugan/rich); best python console formatting lib\n",
    " - [nox](https://github.com/theacodes/nox); like tox but less maddening, in fact it is fantastic\n",
    "\n",
    "___\n",
    "\n",
    "## Notebooks\n",
    "\n",
    "```\n",
    "notebooks/\n",
    "├── cache_money.ipynb\n",
    "├── filter_none.ipynb\n",
    "├── json_parsing.ipynb\n",
    "└── string_fmt.ipynb\n",
    "```\n",
    "\n",
    " - [Filtering None and False-y values](./notebooks/filter_none)\n",
    " - [cache money! `functools.lru_cache`](./notebooks/cache_money)\n",
    " - [String formatting funks](./notebooks/string_fmt)\n",
    " - [JSON parsing vs plain-jane dictionaries](./notebooks/json_parsing)\n",
    "\n",
    "___\n",
    "\n",
    "## Contributor(s):\n",
    " \n",
    " - [Jesse Rubin](https://github.com/jessekrubin) ~ `jesse@dgi.com` / `jessekrubin@gmail.com`\n",
    "\n",
    "## Contributing:\n",
    "\n",
    "Plz do! Send me that PR!\n",
    "\n",
    "___\n",
    "\n",
    "## TODO:\n",
    "\n",
    " - Have CI/CD auto build n publish\n",
    " - Make some sort of change log\n",
    " - Publish packages to conda-forge? (maybe)\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.10.4 (conda)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.9"
  },
  "vscode": {
   "interpreter": {
    "hash": "98a464eb33da0640d5ef19fa2622837e94be66e983ba00d5d042a26eba1ce9bf"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}