From 0952b3cf5fdac234f58c4338c7b54f6389d24d96 Mon Sep 17 00:00:00 2001 From: Nikolay Novik Date: Sat, 27 Oct 2018 22:17:58 +0300 Subject: [PATCH 1/3] add example projects page --- docs/examples.rst | 38 ++++++++++++++++++++++++++++++++++++++ docs/misc.rst | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/examples.rst diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 00000000000..7a647006e33 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,38 @@ +.. _aiohttp-examples: + +================ +Example Projects +================ + +Here are several fun projects, that can be used as template or +inspiration of what can be done with aiohttp. Please feel free to add your +open source example project by making Pull Request. + + +Officiall Example Projects +-------------------------- + +This list contains libraries which are supported by *aio-libs* team +and located at https://github.com/aio-libs/aiohttp-demos + +- `shortify `_ + URL shortener with Redis storage. + +- `moderator `_ + UI and API for classification of offensive and toxic comments using Kaggle + data and scikit-learn. + +- `motortwit `_ + Twitter clone with MongoDB storage. + +- `imagetagger `_ + Example how to deploy deep learning model with aiohttp. + +- `chat `_ + Simple chat using websockets. + +- `polls `_ + Simple *polls* application with PostgreSQL storage. + +- `Blog `_ + Blog application with PostgreSQL storage and Redis session store. diff --git a/docs/misc.rst b/docs/misc.rst index dd9df05e9f5..be2e148534a 100644 --- a/docs/misc.rst +++ b/docs/misc.rst @@ -10,6 +10,7 @@ Helpful pages. essays glossary + examples .. toctree:: :titlesonly: From a7cc3973ef60fec7ba87fe8549c93d266da06f95 Mon Sep 17 00:00:00 2001 From: Nikolay Novik Date: Sat, 27 Oct 2018 22:26:35 +0300 Subject: [PATCH 2/3] spelling --- docs/examples.rst | 4 ++-- docs/spelling_wordlist.txt | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/examples.rst b/docs/examples.rst index 7a647006e33..f09d2d9f2ac 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -9,8 +9,8 @@ inspiration of what can be done with aiohttp. Please feel free to add your open source example project by making Pull Request. -Officiall Example Projects --------------------------- +Official Example Projects +------------------------- This list contains libraries which are supported by *aio-libs* team and located at https://github.com/aio-libs/aiohttp-demos diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 00a685ec51b..b12b63a9046 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -127,6 +127,7 @@ iterables javascript Jinja json +Kaggle keepalive keepalived keepalives @@ -231,6 +232,8 @@ Runit sa Satisfiable schemas +shortener +scikit sendfile serializable shourtcuts From 9b87f493a2330571218862fb3d9e8fd3eaf6aa36 Mon Sep 17 00:00:00 2001 From: Nikolay Novik Date: Sat, 27 Oct 2018 23:11:42 +0300 Subject: [PATCH 3/3] lower case --- docs/examples.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples.rst b/docs/examples.rst index f09d2d9f2ac..641f0a439f5 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -34,5 +34,5 @@ and located at https://github.com/aio-libs/aiohttp-demos - `polls `_ Simple *polls* application with PostgreSQL storage. -- `Blog `_ +- `blog `_ Blog application with PostgreSQL storage and Redis session store.