Initial rename to returns

Author: sobolevn

.travis.yml

@@ -17,8 +17,8 @@ install:
   - poetry install
 
 script:
-  - poetry run flake8 dry_monads tests docs
-  - poetry run mypy dry_monads tests/**/*.py
+  - poetry run flake8 returns tests docs
+  - poetry run mypy returns tests/**/*.py
   - poetry run pytest
   - poetry run doc8 -q docs
   - poetry check

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 We follow Semantic Versions since the `0.1.0` release.
 
+## Version 0.3.0, Renamed to `returns`
+
+The project is renamed to `returns` and moved to `dry-python` org.
+
+### Features
+
+- Adds `.pyi` files for all modules,
+  to enable `mypy` support for 3rd party users
+
+
 ## Version 0.2.0
 
 ### Features

CONTRIBUTING.md

@@ -40,7 +40,7 @@ pytest
 To run linting:
 
 ```bash
-flake8 dry_monads tests docs
+flake8 returns tests docs
 ```
 
 These steps are mandatory during the CI.
@@ -52,7 +52,7 @@ We use `mypy` to run type checks on our code.
 To use it:
 
 ```bash
-mypy dry_monads
+mypy returns
 ```
 
 This step is mandatory during the CI.

README.md

@@ -1,47 +1,47 @@
-# dry-monads
+# returns
 
-[![wemake.services](https://img.shields.io/badge/%20-wemake.services-green.svg?label=%20&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](https://wemake.services) [![Build Status](https://travis-ci.org/sobolevn/dry-monads.svg?branch=master)](https://travis-ci.org/sobolevn/dry-monads) [![Coverage Status](https://coveralls.io/repos/github/sobolevn/dry-monads/badge.svg?branch=master)](https://coveralls.io/github/sobolevn/dry-monads?branch=master) [![Documentation Status](https://readthedocs.org/projects/dry-monads/badge/?version=latest)](https://dry-monads.readthedocs.io/en/latest/?badge=latest) [![Python Version](https://img.shields.io/pypi/pyversions/dry-monads.svg)](https://pypi.org/project/dry-monads/) [![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)
+[![wemake.services](https://img.shields.io/badge/%20-wemake.services-green.svg?label=%20&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](https://wemake.services) [![Build Status](https://travis-ci.org/dry-python/returns.svg?branch=master)](https://travis-ci.org/dry-python/returns) [![Coverage Status](https://coveralls.io/repos/github/dry-python/returns/badge.svg?branch=master)](https://coveralls.io/github/dry-python/returns?branch=master) [![Documentation Status](https://readthedocs.org/projects/returns/badge/?version=latest)](https://returns.readthedocs.io/en/latest/?badge=latest) [![Python Version](https://img.shields.io/pypi/pyversions/returns.svg)](https://pypi.org/project/returns/) [![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)
 
 
-Monads for `python` made simple and safe.
+Make your functions return something meaningful and safe!and safe.
 
 
 ## Features
 
 - Provides primitives to write declarative business logic
 - Fully typed with annotations and checked with `mypy`,
   allowing you to write type-safe code as well
-- No operator overloading or other unpythonic stuff that makes your eyes bleed
+- Pythonic and pleasant to write and to read (!)
 
 
 ## Installation
 
 
 ```bash
-pip install dry-monads
+pip install returns
 ```
 
 
 ## What's inside?
 
 We have several the most iconic monads inside:
 
-- [Result, Failure, and Success](https://dry-monads.readthedocs.io/en/latest/pages/either.html) (also known as `Either`, `Left`, and `Right`)
-- [Maybe, Some, and Nothing](https://dry-monads.readthedocs.io/en/latest/pages/maybe.html)
+- [Result, Failure, and Success](https://returns.readthedocs.io/en/latest/pages/either.html) (also known as `Either`, `Left`, and `Right`)
+- [Maybe, Some, and Nothing](https://returns.readthedocs.io/en/latest/pages/maybe.html)
 
 We also care about code readability and developer experience,
 so we have included some useful features to make your life easier:
 
-- [Do notation](https://dry-monads.readthedocs.io/en/latest/pages/do-notation.html)
-- [Helper functions](https://dry-monads.readthedocs.io/en/latest/pages/functions.html)
+- [Do notation](https://returns.readthedocs.io/en/latest/pages/do-notation.html)
+- [Helper functions](https://returns.readthedocs.io/en/latest/pages/functions.html)
 
 
 ## Example
 
 
 ```python
-from dry_monads.do_notation import do_notation
-from dry_monads.either import Result, Success, Failure
+from returns.do_notation import do_notation
+from returns.either import Result, Success, Failure
 
 class CreateAccountAndUser(object):
     """Creates new Account-User pair."""
@@ -58,7 +58,8 @@ class CreateAccountAndUser(object):
 
 ```
 
-We are [covering what's going on in this example](https://dry-monads.readthedocs.io/en/latest/pages/do-notation.html) in the docs.
+We are [covering what's going on in this example](https://returns.readthedocs.io/en/latest/pages/do-notation.html) in the docs.
+
 
 ## Inspirations
 

docs/_templates/moreinfo.html

@@ -3,15 +3,15 @@ <h3>
 </h3>
 <ul>
     <li>
-        <a href="https://github.com/sobolevn/dry-monads">GitHub</a>
+        <a href="https://github.com/dry-python/returns">GitHub</a>
     </li>
     <li>
-        <a href="https://pypi.python.org/pypi/dry-monads">PyPI</a>
+        <a href="https://pypi.python.org/pypi/returns">PyPI</a>
     </li>
     <li>
-        <a href="https://travis-ci.org/sobolevn/dry-monads">Travis CI</a>
+        <a href="https://travis-ci.org/dry-python/returns">Travis CI</a>
     </li>
     <li>
-        <a href="https://coveralls.io/github/sobolevn/dry-monads?branch=master">Coverage</a>
+        <a href="https://coveralls.io/github/dry-python/returns?branch=master">Coverage</a>
     </li>
 </ul>

docs/conf.py

@@ -118,10 +118,10 @@ def _get_project_meta():
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'logo_name': 'dry-monads',
+    'logo_name': 'returns',
     'description': 'Monads for python made simple and safe',
-    'github_user': 'sobolevn',
-    'github_repo': 'dry-monads',
+    'github_user': 'dry-python',
+    'github_repo': 'returns',
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/pages/do-notation.rst

@@ -25,8 +25,8 @@ Here's the code to illustrate the task.
 
 .. code:: python
 
-  from dry_monads.do_notation import do_notation
-  from dry_monads.either import Result, Success, Failure
+  from returns.do_notation import do_notation
+  from returns.either import Result, Success, Failure
 
 
   class CreateAccountAndUser(object):
@@ -130,7 +130,7 @@ And at the same time the produced code is simple and readable.
 And that's it!
 
 See also:
-  - https://dry-rb.org/gems/dry-monads/do-notation/
+  - https://dry-rb.org/gems/returns/do-notation/
   - https://en.wikibooks.org/wiki/Haskell/do_notation
   - https://wiki.haskell.org/Do_notation_considered_harmful
 
@@ -143,16 +143,16 @@ due to `mypy issue <https://github.com/python/mypy/issues/3157>`_:
 
 .. code:: python
 
-  from dry_monads.do_notation import do_notation
-  from dry_monads.either import Success
+  from returns.do_notation import do_notation
+  from returns.either import Success
 
   @do_notation
   def function(param: int) -> Success[int]:
       return Success(param)
 
   reveal_type(function)
-  # Actual => def (*Any, **Any) -> dry_monads.either.Right*[builtins.int]
-  # Expected => def (int) -> dry_monads.either.Right*[builtins.int]
+  # Actual => def (*Any, **Any) -> returns.either.Right*[builtins.int]
+  # Expected => def (int) -> returns.either.Right*[builtins.int]
 
 This effect can be reduced with the help of `Design by Contract <https://en.wikipedia.org/wiki/Design_by_contract>`_
 with these implementations:
@@ -164,5 +164,5 @@ with these implementations:
 API Reference
 -------------
 
-.. automodule:: dry_monads.do_notation
+.. automodule:: returns.do_notation
    :members:

docs/pages/either.rst

@@ -13,7 +13,7 @@ and ``Failure`` indicates that something has failed.
 
 .. code:: python
 
-  from dry_monads.either import Result, Success, Failure
+  from returns.either import Result, Success, Failure
 
   def find_user(user_id: int) -> Either['User', str]:
       user = User.objects.filter(id=user_id)
@@ -36,7 +36,7 @@ and other ``None`` exception-friends.
 API Reference
 -------------
 
-.. autoclasstree:: dry_monads.either
+.. autoclasstree:: returns.either
 
-.. automodule:: dry_monads.either
+.. automodule:: returns.either
    :members:

docs/pages/functions.rst

@@ -6,17 +6,17 @@ We feature several helper functions to make your developer experience better.
 is_successful
 -------------
 
-:func:`is_succesful <dry_monads.functions.is_successful>` is used to
+:func:`is_succesful <returns.functions.is_successful>` is used to
 tell whether or not your monad is a success.
 We treat only treat monads that does not throw as a successful ones,
-basically: :class:`Right <dry_monads.either.Right>`
-and :class:`Some <dry_monads.maybe.Some>`.
+basically: :class:`Right <returns.either.Right>`
+and :class:`Some <returns.maybe.Some>`.
 
 .. code:: python
 
-  from dry_monads.either import Success, Failure
-  from dry_monads.functions import is_successful
-  from dry_monads.maybe import Some, Nothing
+  from returns.either import Success, Failure
+  from returns.functions import is_successful
+  from returns.maybe import Some, Nothing
 
   is_successful(Some(1)) and is_successful(Success(1))
   # => True
@@ -27,13 +27,13 @@ and :class:`Some <dry_monads.maybe.Some>`.
 safe
 ----
 
-:func:`safe <dry_monads.functions.safe>` is used to convert
+:func:`safe <returns.functions.safe>` is used to convert
 regular functions that can throw exceptions to functions
-that return :class:`Either <dry_monads.either.Either>` monad.
+that return :class:`Either <returns.either.Either>` monad.
 
 .. code:: python
 
-  from dry_monads.functions import safe
+  from returns.functions import safe
 
   @safe
   def divide(number: int) -> float:
@@ -48,5 +48,5 @@ that return :class:`Either <dry_monads.either.Either>` monad.
 API Reference
 -------------
 
-.. automodule:: dry_monads.functions
+.. automodule:: returns.functions
    :members:

docs/pages/maybe.rst

@@ -13,7 +13,7 @@ based on just a single value:
 
 .. code:: python
 
-  from dry_monads.maybe import Maybe
+  from returns.maybe import Maybe
 
   Maybe.new(1)
   # => Some(1)
@@ -56,7 +56,7 @@ It might be very useful for complex operations like the following one:
 API Reference
 -------------
 
-.. autoclasstree:: dry_monads.maybe
+.. autoclasstree:: returns.maybe
 
-.. automodule:: dry_monads.maybe
+.. automodule:: returns.maybe
    :members: