Skip to content

Commit

Permalink
Rename project files
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex0Blackwell committed Oct 2, 2023
1 parent 581162e commit 4783f61
Show file tree
Hide file tree
Showing 15 changed files with 84 additions and 8 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
.venv
__pycache__
__pycache__
build
dist
*.egg-info
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Alex Blackwell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Py-Strict
## Python's missing runtime type checker

Readme incoming.

Basic usage:

```py
from py_strict import strict

@strict
def person_age(name: str, age: int) -> str
return f"{name} is {age}"

# If the values mismatch the types, a TypeError is thrown.
person_age(...)
```
10 changes: 10 additions & 0 deletions py_strict/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
"""
py_strict.
Python's missing runtime type checker
"""

from strict import strict

__version__ = "0.1.1"
__author__ = "Alex Blackwell"
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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_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 python_typing.strict import strict
from py_strict.strict import strict


def test_tuple_arg():
Expand Down
Empty file removed python_typing_tests/__init__.py
Empty file.
25 changes: 25 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
from pathlib import Path

from setuptools import setup

this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
name="py-strict",
version="0.1.1",
description="Python's missing runtime type checker",
# url='https://github.com/',
author="Alex Blackwell",
author_email="[email protected]",
license="MIT",
packages=["py_strict"],
long_description=long_description,
long_description_content_type="text/markdown",
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.9",
)

0 comments on commit 4783f61

Please sign in to comment.