Prepare for pypi release

This commit is contained in:
Correl Roush 2018-11-29 11:01:31 -05:00
parent b798eb74ba
commit 8e5b34f4f9
3 changed files with 37 additions and 15 deletions

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# Type-safe Monads
This is an experiment in building monads in Python supported by strict
type annotations. The goal is to be able to compose monads with the
type checker ensuring their correctness.
## Motivation
I'm a fan of monads, but believe they work best with the support of a
strong type system. I've attempted to use libraries like
[PyMonad](https://pypi.org/project/PyMonad/), but been frustrated by a
lack of type constraints preventing incorrect usage. I could've
attempted to add type annotations to one of those libraries, but
building my own is more fun.

View file

@ -1,13 +0,0 @@
#+TITLE: Type-safe Monads
This is an experiment in building monads in Python supported by strict
type annotations. The goal is to be able to compose monads with the
type checker ensuring their correctness.
* Motivation
I'm a fan of monads, but believe they work best with the support of a
strong type system. I've attempted to use libraries like [[https://pypi.org/project/PyMonad/][PyMonad]], but
been frustrated by a lack of type constraints preventing incorrect
usage. I could've attempted to add type annotations to one of those
libraries, but building my own is more fun.

View file

@ -1,9 +1,28 @@
from setuptools import setup # type: ignore
with open("README.md", "r") as f:
long_description = f.read()
setup(
name="Typesafe Monads",
version="0.1dev",
name="typesafe-monads",
version="0.2",
author="Correl Roush",
author_email="correl@gmail.com",
description="Type-annotated monad implementations for Python 3.7+",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/correl/typesafe-monads",
packages=["monads"],
setup_requires=["pytest-runner"],
tests_require=["pytest", "mypy", "pytest-mypy"],
classifiers=[
"Development Status :: 2 - Pre-Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Topic :: Software Development :: Libraries",
],
)