Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waylonwalker/engorgio
https://github.com/waylonwalker/engorgio
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/waylonwalker/engorgio
- Owner: WaylonWalker
- License: mit
- Created: 2023-06-03T17:15:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-13T01:34:42.000Z (about 1 year ago)
- Last Synced: 2024-12-09T07:09:12.699Z (about 1 month ago)
- Language: Python
- Size: 35.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# engorgio
Expands function arguments into fields.
https://user-images.githubusercontent.com/22648375/235036031-a9dc6589-e350-4a18-9114-6568cb362f74.mp4
## Installation
pypi package to come if this works out, and I can decide
what to call it. I think its possible to do this for other
objects like dataclasses as well.
```console
pip install git+https://github.com/WaylonWalker/engorgio.gi
```
## Usage
Setup your models.
```python
from typing import Optional
from pydantic import BaseModel, Field
class Alpha(BaseModel):
a: int
class Color(BaseModel):
r: int
g: int
b: int
alpha: Alpha
class Hair(BaseModel):
color: Color
length: int
class Person(BaseModel):
name: str
other_name: Optional[str] = None
age: int
email: Optional[str]
pet: str = "dog"
address: str = Field("123 Main St", description="Where the person calls home.")
hair: Hair
```
Now create a typer command using your models.
`engorgio` will expand all of the typer fields
for you.
```python
import typer
from engorgio import engorgio
app = typer.Typer(
name="engorgio",
help="a demo app",
)
@app.command()
@engorgio
def get_person(person: Person) -> Person:
"""Get a person's information."""
from rich import print
print(person)
```
Get the help message.
```console
engorgio get-person --help
Usage: engorgio get-person [OPTIONS]
Get a person's information.
╭─ Options ──────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Person ───────────────────────────────────────────────────────────────────────────────╮
│ * --name TEXT [default: None] [required] │
│ --other-name TEXT [default: None] │
│ * --age INTEGER [default: None] [required] │
│ --email TEXT [default: None] │
│ --pet TEXT [default: dog] │
│ --address TEXT Where the person calls home. [default: 123 Main St] │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Person.Hair ──────────────────────────────────────────────────────────────────────────╮
│ * --length INTEGER [default: None] [required] │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Person.Hair.Color ────────────────────────────────────────────────────────────────────╮
│ * --r INTEGER [default: None] [required] │
│ * --g INTEGER [default: None] [required] │
│ * --b INTEGER [default: None] [required] │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Person.Hair.Color.Alpha ──────────────────────────────────────────────────────────────╮
│ * --a INTEGER [default: None] [required] │
╰────────────────────────────────────────────────────────────────────────────────────────╯
```
Calling the cli will print out a Person object.
```console
engorgio get-person --name me --age 1 --r 1 --g 1 --b 1 --a 1 --length 1
```
Calling the cli while not specifying required arguments will automatically prompt for them.
```console
engorgio get-person
```
## License
`engorgio` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.