Repos · Library

owner/repo-name

One or two sentences on what the repository does and who would want it.

Python MIT v1.4.0 ★ 120 Active

What it does

A few paragraphs describing the problem the code solves and the approach it takes. Write for someone who has just landed here from a search result and is deciding whether to open the repository.

Install

pip install repo-name

Usage

The shortest possible working example:

from repo_name import Thing

t = Thing(config="default")
t.run()

Design notes

  • A decision you made and why.
  • A limitation the reader should know about before adopting it.
  • What is planned next, if anything.

Related

Link to the paper this code accompanies, the post that explains it, or the toy built on top of it.