Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JonesBeach committed Nov 12, 2024
1 parent 68a02b5 commit 6a94198
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down

0 comments on commit 6a94198

Please sign in to comment.