Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

A Type-Safe UI/CLI Generator powered by Pydantic and Prompt-Toolkit.

[![PyPI version](https://img.shields.io/pypi/v/typerform.svg)](https://pypi.org/project/typerform/)
[![Python](https://img.shields.io/pypi/pyversions/typerform.svg)](https://pypi.org/project/typerform/)
[![CI](https://github.com/sthitaprajnas/typerform/actions/workflows/ci.yml/badge.svg)](https://github.com/sthitaprajnas/typerform/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/typeform.svg)](https://pypi.org/project/typeform/)
[![Python](https://img.shields.io/pypi/pyversions/typeform.svg)](https://pypi.org/project/typeform/)
[![CI](https://github.com/sthitaprajnas/typeform/actions/workflows/ci.yml/badge.svg)](https://github.com/sthitaprajnas/typeform/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/license-Apache%202.0-green)](LICENSE)
[![Typed](https://img.shields.io/badge/typing-py.typed-informational)](src/typerform/py.typed)
[![Typed](https://img.shields.io/badge/typing-py.typed-informational)](src/typeform/py.typed)

Typerform transforms your Pydantic models into professional, interactive CLI wizards. Stop writing boilerplate input loops and manual validation—let your schemas drive the user experience.

Expand All @@ -26,15 +26,15 @@ Typerform transforms your Pydantic models into professional, interactive CLI wiz
## Installation

```bash
pip install typerform
pip install typeform
```

## Quick Start

```python
from typing import Literal
from pydantic import BaseModel, Field
from typerform import form
from typeform import form

class SetupConfig(BaseModel):
project_name: str = Field(description="Project Name", min_length=3)
Expand Down Expand Up @@ -90,12 +90,12 @@ config = form(MyModel, hydrate_from=[os.environ])
Contributions are welcome! Whether it's bug reports, feature requests, or new prompt engines.

```bash
git clone https://github.com/sthitaprajnas/typerform.git
cd typerform
git clone https://github.com/sthitaprajnas/typeform.git
cd typeform
pip install -e ".[dev]"
pytest # run test suite
ruff check src/typerform # lint
mypy src/typerform # type-check
ruff check src/typeform # lint
mypy src/typeform # type-check
```

## License
Expand Down
2 changes: 1 addition & 1 deletion examples/collection_wizard.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Add src to sys.path
sys.path.insert(0, "./src")

from typerform import form
from typeform import form
from rich.console import Console

console = Console()
Expand Down
2 changes: 1 addition & 1 deletion examples/enterprise_wizard.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Add the src directory to sys.path
sys.path.insert(0, "./src")

from typerform import form
from typeform import form
from rich.console import Console

console = Console()
Expand Down
4 changes: 2 additions & 2 deletions examples/simple_wizard.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

from pydantic import BaseModel, EmailStr, Field

# Add the src directory to sys.path so we can import typerform without installing it
# Add the src directory to sys.path so we can import typeform without installing it
sys.path.insert(0, "./src")

from rich.console import Console

from typerform import form
from typeform import form

console = Console()

Expand Down
2 changes: 1 addition & 1 deletion examples/ultimate_demo.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# Add src to sys.path
sys.path.insert(0, "./src")

from typerform import form
from typeform import form
from rich.console import Console

console = Console()
Expand Down
2 changes: 1 addition & 1 deletion examples/ultimate_wizard.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# Add src to sys.path
sys.path.insert(0, "./src")

from typerform import form
from typeform import form
from rich.console import Console

console = Console()
Expand Down
16 changes: 8 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ build-backend = "hatchling.build"
# ---------------------------------------------------------------------------

[project]
name = "typerform"
name = "pytypeform"
version = "0.2.0"
description = "A Type-Safe UI/CLI Generator powered by Pydantic."
readme = "README.md"
Expand Down Expand Up @@ -47,10 +47,10 @@ dependencies = [
]

[project.urls]
Homepage = "https://github.com/sthitaprajnas/typerform"
Repository = "https://github.com/sthitaprajnas/typerform"
Documentation = "https://github.com/sthitaprajnas/typerform#readme"
Issues = "https://github.com/sthitaprajnas/typerform/issues"
Homepage = "https://github.com/sthitaprajnas/typeform"
Repository = "https://github.com/sthitaprajnas/typeform"
Documentation = "https://github.com/sthitaprajnas/typeform#readme"
Issues = "https://github.com/sthitaprajnas/typeform/issues"

[project.optional-dependencies]
dev = [
Expand All @@ -67,7 +67,7 @@ dev = [
# ---------------------------------------------------------------------------

[tool.hatch.build.targets.wheel]
packages = ["src/typerform"]
packages = ["src/typeform"]

[tool.hatch.build.targets.sdist]
include = [
Expand All @@ -89,7 +89,7 @@ addopts = "-v --tb=short"
[tool.mypy]
strict = true
python_version = "3.10"
files = ["src/typerform"]
files = ["src/typeform"]

[tool.ruff]
line-length = 100
Expand All @@ -100,7 +100,7 @@ select = ["E", "F", "I", "UP", "B", "SIM"]
ignore = ["E501"]

[tool.coverage.run]
source = ["src/typerform"]
source = ["src/typeform"]

[tool.coverage.report]
show_missing = true
Expand Down
File renamed without changes.
File renamed without changes.
Binary file removed src/typerform/__pycache__/__init__.cpython-313.pyc
Binary file not shown.
Binary file removed src/typerform/__pycache__/core.cpython-313.pyc
Binary file not shown.
Binary file modified tests/__pycache__/test_core.cpython-313-pytest-9.0.3.pyc
Binary file not shown.
Binary file modified tests/__pycache__/test_extended.cpython-313-pytest-9.0.3.pyc
Binary file not shown.
4 changes: 2 additions & 2 deletions tests/test_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
from unittest.mock import MagicMock

from pydantic import BaseModel, Field, SecretStr
from typerform import form
from typerform.core import PromptEngine, set_engine, config
from typeform import form
from typeform.core import PromptEngine, set_engine, config
import io
from rich.console import Console

Expand Down
4 changes: 2 additions & 2 deletions tests/test_extended.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
from typing import Literal, Optional, Any, Dict
from enum import Enum
from pydantic import BaseModel, Field, SecretStr
from typerform import form
from typerform.core import PromptEngine, set_engine, config
from typeform import form
from typeform.core import PromptEngine, set_engine, config
import io
from rich.console import Console

Expand Down
Loading