From 6a941980def2d3b31ed275eaa17372f265b257b7 Mon Sep 17 00:00:00 2001 From: Jones Beach Date: Tue, 12 Nov 2024 16:57:56 -0500 Subject: [PATCH] Update README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c204903..fff283f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # python-interfaces +This project is a learning exercise in Python metaprogramming. I wondered what Java-style interfaces would look like in Python. + +For a tad more context, you can read [this blog post](https://tyleragreen.com/blog/2018/12/bringing-interfaces-to-python/). ## Installation -``` +```bash pip install python-interfaces ``` ## Usage -``` +```python from interface import interface class Iterable: @@ -19,7 +22,7 @@ class Foo: # raises InterfaceException ``` ## Local Development -``` +```bash git clone https://github.com/tyleragreen/python-interfaces.git && cd python-interfaces virtualenv ~/.env/interface source ~/.env/interface/bin/activate