Skip to content

Commit 97ebf2a

Browse files
authored
Adds quickstart (#664)
1 parent 3ecccd2 commit 97ebf2a

File tree

6 files changed

+85
-8
lines changed

6 files changed

+85
-8
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# How to contribute
22

3+
Do you have questions or issues? Join our chat!
4+
5+
[![Telegram chat](https://img.shields.io/badge/chat-join-blue?logo=telegram)](https://t.me/drypython)
6+
37
## Tutorials
48

59
If you want to start working on this project,
@@ -65,7 +69,7 @@ poetry run pytest typesafety
6569

6670
**NOTE:** This can take upwards of 20 minutes, only recommended to run if necessary.
6771

68-
Here's [a helpful tutorial](https://sobolevn.me/2019/08/testing-mypy-types) if you are looking
72+
Here's [a helpful tutorial](https://sobolevn.me/2019/08/testing-mypy-types) if you are looking
6973
for more information.
7074

7175

@@ -123,5 +127,5 @@ It would also be a huge contribution to write
123127
a short article on how you are using this project.
124128
You can also share your best practices with us.
125129

126-
Join in the conversation with us on our Telegram.
130+
Join in the conversation with us on our Telegram.
127131
[![Telegram chat](https://img.shields.io/badge/chat-join-blue?logo=telegram)](https://t.me/drypython)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Make your functions return something meaningful, typed, and safe!
2828
- Support functions and coroutines, framework agnostic
2929
- Easy to start: has lots of docs, tests, and tutorials
3030

31+
[Quickstart](https://returns.readthedocs.io/en/latest/pages/quickstart.html) right now!
32+
3133

3234
## Installation
3335

docs/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Contents
44
--------
55

6+
.. toctree::
7+
:maxdepth: 2
8+
9+
pages/quickstart.rst
10+
611
.. toctree::
712
:maxdepth: 2
813
:caption: Userguide

docs/pages/contrib/mypy_plugins.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
mypy plugin
44
===========
55

6-
We provide several ``mypy`` plugins to fix existing issues
7-
and improve type-safety of things developers commonly use:
8-
9-
- ``returns_plugin`` to solve untyped `decorator issue <https://github.com/python/mypy/issues/3157>`_ and add better :ref:`curry` support
6+
We provide a custom ``mypy`` plugin to fix existing issues,
7+
provide new awesome features,
8+
and improve type-safety of things developers commonly use.
109

1110

1211
Installation

docs/pages/development.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Development
2-
===========
1+
.. _development-tooling:
2+
3+
Development tooling
4+
===================
35

46
Tracing Failures
57
----------------

docs/pages/quickstart.rst

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
Quickstart
2+
==========
3+
4+
Starting is really fast!
5+
You can intergrate ``returns`` into any project at any stage.
6+
You can use it fully or partially. With or without types.
7+
8+
``returns`` is a very flexible library!
9+
10+
You can even just start using it without any deep theory around this project.
11+
But, you can always address our learning materials
12+
which will unravel all parts of functional programming
13+
with useful examples and simple terms.
14+
15+
16+
Installation
17+
------------
18+
19+
``returns`` is a pure Python library. Install it as usual:
20+
21+
.. code:: bash
22+
23+
pip install returns # or better use poetry
24+
25+
26+
Typechecking and other integrations
27+
-----------------------------------
28+
29+
This step is optional.
30+
If you use ``mypy`` for type-checking, than you will need to configure it.
31+
We really recommend using ``mypy`` with this project though.
32+
Because we have put a lot of efforts into the typing part.
33+
34+
Check out our docs on :ref:`mypy <mypy-plugins>`.
35+
36+
We also have built-in integrations
37+
with :ref:`pytest <pytest-plugins>` and :ref:`hypothesis <hypothesis-plugins>`.
38+
Also, there is :ref:`developer tooling <development-tooling>` you might enjoy.
39+
40+
41+
Theory
42+
------
43+
44+
Do you want to learn new awesome concepts?
45+
Then, start reading our "Userguide"!
46+
47+
It has everything you need! Reading order matters.
48+
49+
However, this is optional.
50+
You can still use ``returns`` without a deep-dive into theory.
51+
52+
53+
Building your own stuff
54+
-----------------------
55+
56+
You can extend ``returns`` and build your own stuff!
57+
Particullary, you can add new interfaces, new containers, and new integrations.
58+
See :ref:`this guide <create-your-own-container>`.
59+
60+
|Telegram chat|
61+
62+
.. |Telegram chat| image:: https://img.shields.io/badge/chat-join-blue?logo=telegram
63+
:target: https://t.me/drypython
64+
65+
Join our chat to get help or advice.

0 commit comments

Comments
 (0)