Skip to content

Commit

Permalink
Rename py-strict to type-strict
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex0Blackwell committed Oct 2, 2023
1 parent c195bbd commit eb0f006
Show file tree
Hide file tree
Showing 12 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Py-Strict
# Type-Strict
Python's missing runtime type checker

## Installation

```
pip install py-strict
pip install type-strict
```

## Usage

```py
from py_strict import strict
from type_strict import strict

@strict
def person_age(name: str, age: int) -> str
Expand Down Expand Up @@ -44,7 +44,7 @@ def func(person: Person, employee: Employee):
4. Checks return type if specified.
5. Works with any combination of args, kwargs, and defaults.
6. Informative error messages.
7. In the event of a failure, Py-Strict swallows the error to avoid user impact.
7. In the event of a failure, type-strict swallows the error to avoid user impact.

## Limitations
1. **Performance:** Type checking is done at _runtime_. So, there is a performance
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
long_description = (this_directory / "README.md").read_text()

setup(
name="py-strict",
name="type-strict",
version="0.1.0",
description="Python's missing runtime type checker",
# url='https://github.com/',
url='https://github.com/Alex0Blackwell/type-strict',
author="Alex Blackwell",
author_email="alex.blackwell314@gmail.com",
license="MIT",
packages=["py_strict"],
packages=["type_strict"],
long_description=long_description,
long_description_content_type="text/markdown",
classifiers=[
Expand Down
2 changes: 1 addition & 1 deletion py_strict/__init__.py → type_strict/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
py_strict.
type_strict.
Python's missing runtime type checker
"""
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_custom_arg():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_default():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_dict_arg():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_list_arg():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_set_arg():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_empty():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest

from py_strict.strict import strict
from type_strict.strict import strict


def test_tuple_arg():
Expand Down

0 comments on commit eb0f006

Please sign in to comment.