Metadata-Version: 2.1
Name: simplestr
Version: 0.2
Summary: Simple annotations to automatically generate __str__(self) and __repr__(self) methods in classes
Home-page: https://github.com/jpleorx/simplestr
Author: Leo Ertuna
Author-email: leo.ertuna@gmail.com
License: MIT
Download-URL: https://pypi.org/project/simplestr/
Keywords: str,repr,generate,automatic,annotation
Platform: UNKNOWN
Description-Content-Type: text/markdown

# simplestr
A python package with annotations to automatically generate `__str__(self)` and `__repr__(self)` methods in classes


# Description
This package provides only two annotations:
- `@gen_str` to generate `__str__(self)` method
- `@gen_repr` to generate `__repr__(self)` method

# Installation

## Normal installation

```bash
pip install simplestr
```

## Development installation

```bash
git clone https://github.com/jpleorx/simplestr.git
cd simplestr
pip install --editable .
```

# Example
```python
from simplestr import gen_str, gen_repr

@gen_str
@gen_repr
class Rect:
    def __init__(self, x: int, y: int, w: int, h: int):
        self.x = x
        self.y = y
        self.w = w
        self.h = h

rect1 = Rect(1, 2, 3, 4)
rect2 = Rect(10, 20, 30, 40)
print(rect1)
print(rect2)
print([rect1, rect2])
```

```
Rect{x=1, y=2, w=3, h=4}
Rect{x=10, y=20, w=30, h=40}
[Rect{x=1, y=2, w=3, h=4}, Rect{x=10, y=20, w=30, h=40}]
```

