master: Merge branch 'release/1.0.1' # Please enter a commit message …

…to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

.github/workflows/gen-docs.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Setup mdBook
       uses: peaceiris/actions-mdbook@v1
       with:
-        mdbook-version: '0.4.3'
+        mdbook-version: '0.4.4'
 
     - name: Build docs
       run: mdbook build docs

CHANGELOG.md

@@ -1,6 +1,16 @@
 # Version history
 We follow [Semantic Versions](https://semver.org/).
 
+## 1.0.1 - Improving docs
+
+### Important changes
+- Improving docs [#91](https://github.com/Uma-Tech/parrot/pull/91)
+
+### Updating dependencies
+- django-simpleui from 2020.9.26 to 2021.1.1 [#80](https://github.com/Uma-Tech/parrot/pull/80)
+- pytest from 6.1.2 to 6.2.1 [#88](https://github.com/Uma-Tech/parrot/pull/88)
+- uvicorn from 0.12.3 to 0.13.2 [#89](https://github.com/Uma-Tech/parrot/pull/89)
+
 ## 1.0.0 - First stable release
 ### New functionality
 - Custom script for each request [#70](https://github.com/Uma-Tech/parrot/pull/70)

README.md

@@ -17,7 +17,9 @@ Code quality:
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Uma-Tech_parrot&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=Uma-Tech_parrot)
 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Uma-Tech_parrot&metric=security_rating)](https://sonarcloud.io/dashboard?id=Uma-Tech_parrot)
 
----
+<br>
+<br>
+<br>
 
 <p align="center">
     <img src="https://github.com/Uma-Tech/parrot/raw/master/static/parrot_icon.png">
@@ -30,118 +32,6 @@ Code quality:
 1. Issue tracker: [https://github.com/Uma-Tech/parrot/issues](https://github.com/Uma-Tech/parrot/issues)
 1. Changelog: [https://github.com/Uma-Tech/parrot/blob/develop/CHANGELOG.md](https://github.com/Uma-Tech/parrot/blob/develop/CHANGELOG.md)
 
-## Quickstart (with Docker)
-1. Clone the repo
-    ```shell
-    git clone git@github.com:Uma-Tech/parrot.git
-    ```
-
-1. Build or download the docker image  
-    _for build_
-    ```shell
-    make build
-    ```
-    _for download_
-    ```shell script
-    docker pull umahighload/parrot-app:latest
-    ```
-
-1. Apply migrations and create a superuser:
-    ```shell
-    make shell
-    # inside the container
-    python manage.py migrate  # apply migrations
-    python manage.py createsuperuser  # create a superuser
-    exit  ## leave from the container
-    ```
-
-1. Start app with required services
-    ```shell
-    make runserver
-    ```
-
-1. Service will be available at `http://127.0.0.1:8042/`
-
-## Start the project for development without Docker
-1. Clone the repo and go to the project directory
-    ```shell
-    git clone git@github.com:Uma-Tech/parrot.git
-    cd parrot
-    ```
-
-1. Install dependencies
-    ```shell
-    poetry install
-    ```
-
-1. Start databases  
-    _You can start databases in any other way_
-   ```shell
-    # start postgres
-   docker run \
-       --name postgres \
-       -d \
-       --rm \
-       -e POSTGRES_PASSWORD=parrot \
-       -e POSTGRES_USER=parrot \
-       --network host \
-       -v parrot_db:/var/lib/postgresql/data \
-       postgres
-   
-    # start redis
-   docker run \
-       --name redis \
-       -d \
-       --rm \
-       --network host \
-       redis
-    ```
-
-1. Setting required environment variables  
-   _Alternatively, you can create a local `.env` file with the variables_
-    ```shell
-    export PARROT_DB_HOST=127.0.0.1
-    export PARROT_SECRET_KEY=NO_SECRET
-    export PARROT_CELERY_BROKER_URL=redis://127.0.0.1
-    ```
-
-1. Build static
-    ```shell
-    poetry run python manage.py collectstatic --no-input
-    ```
-
-1. Apply database migrations
-    ```shell
-    poetry run python manage.py migrate
-    ```
-
-1. Create a django superuser
-    ```shell
-    poetry run python manage.py createsuperuser
-    ```
-
-1. Start the django app
-    ```shell
-    poetry run python manage.py runserver
-    ```
-
-1. Start the celery worker  
-   _Run in a separate terminal window_
-    ```shell
-    poetry run celery -A parrot worker -l INFO -c 4
-    ```
-
-
-## System requirements
-* docker ([https://www.docker.com/](https://www.docker.com/))
-* docker-compose
-    ([https://github.com/docker/compose](https://github.com/docker/compose))
-* make
-    ([https://www.gnu.org/software/make/](https://www.gnu.org/software/make/))
-    _(all commands can be viewed by calling `make` without parameters)_
-* poetry _(for development)_
-  ([https://python-poetry.org/](https://python-poetry.org/))
-
 ## Components
 1. Database postgres.
 1. Database redis (for background celery-tasks).

docs/src/SUMMARY.md

@@ -1,11 +1,16 @@
 # Summary
 # Parrot
 
-- [About Parrot!](./index.md)
-- [Quick Start](./quick_start.md)
-    - [System requires](./qs_system_requires.md)
-    - [Local run](./qs_local_run.md)
-    - [Usage](./qs_usage.md)
-- [Contributing](./contributing.md)
+- [About Parrot!](index.md)
+- [Quick Start](quick-start/index.md)
+    - [System requires](quick-start/system-requires.md)
+    - [Local run](quick-start/local-run.md)
+- [Usage](usage/index.md)
+    - [First steps](usage/first-steps.md)
+    - [Request scripts](usage/request-scripts.md)
+- [Changelog](changelog.md)
+- [Contributing](contributing.md)
+
 ---
-[Contributors](./contributors.md)
+
+[Contributors](contributors.md)

docs/src/changelog.md

@@ -0,0 +1 @@
+{{#include ../../CHANGELOG.md}}

docs/src/contributing.md

@@ -1,7 +1 @@
-# Contributing
-
-We welcome all contributions!  
-See [CONTRIBUTING.md](https://github.com/Uma-Tech/parrot/blob/develop/CONTRIBUTING.md)
-if you want to contribute.  
-You can start with [issues that need some help](https://github.com/Uma-Tech/parrot/issues)
-right now.
+{{#include ../../CONTRIBUTING.md}}

docs/src/contributors.md

@@ -2,3 +2,4 @@
 
 - Evgeniy [lowitea](https://github.com/lowitea)  
 - Eugene Morozov [emorozov](https://github.com/emorozov)
+- Petr [PetrS](https://github.com/PetrS12)

docs/src/index.md

@@ -1,27 +1,4 @@
-# Parrot
-_Web-service for testing http requests and webhooks._
-
-[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/umahighload/parrot-app/latest)](https://registry.hub.docker.com/r/umahighload/parrot-app)
-![Python Version](https://img.shields.io/static/v1?label=python&message=3.8&color=blue)
-![License](https://img.shields.io/static/v1?label=license&message=Apache+2&color=blue)
-
-<p align="center">
-    <br />
-    <br />
-    <img src="https://github.com/Uma-Tech/parrot/raw/master/static/parrot_icon.png">
-    <br />
-</p>
-
-## Links:
-1. Repository: [https://github.com/Uma-Tech/parrot](https://github.com/Uma-Tech/parrot)
-1. Documentation: [https://uma-tech.github.io/parrot/](https://uma-tech.github.io/parrot/)
-1. Docker Hub: [https://registry.hub.docker.com/r/umahighload/parrot-app](https://registry.hub.docker.com/r/umahighload/parrot-app)
-1. Issue tracker: [https://github.com/Uma-Tech/parrot/issues](https://github.com/Uma-Tech/parrot/issues)
-1. Changelog: [https://github.com/Uma-Tech/parrot/blob/develop/CHANGELOG.md](https://github.com/Uma-Tech/parrot/blob/develop/CHANGELOG.md)
-
-## Components
-1. Postgres database.
-1. Python-app based on Django Web Framework.
+{{#include ../../README.md}}
 
 ## Screenshots
 ![](./images/01.jpg)

docs/src/quick-start/index.md

@@ -0,0 +1,4 @@
+# Quick Start
+
+1. [System requires](system-requires.md)
+1. [Local run](local-run.md)

docs/src/quick-start/local-run.md

@@ -0,0 +1,103 @@
+# Local run
+
+## Quickstart (with Docker)
+1. Clone the repo
+    ```shell
+    git clone git@github.com:Uma-Tech/parrot.git
+    cd parrot
+    ```
+
+1. Build or download the docker image  
+    _for build_
+    ```shell
+    make build
+    ```
+    _for download_
+    ```shell script
+    docker pull umahighload/parrot-app:latest
+    ```
+
+1. Apply migrations and create a superuser:
+    ```shell
+    make shell
+    # inside the container
+    python manage.py migrate  # apply migrations
+    python manage.py createsuperuser  # create a superuser
+    exit  ## leave from the container
+    ```
+
+1. Start the app and its dependencies
+    ```shell
+    make runserver
+    ```
+
+1. You will be able to access the service at `http://127.0.0.1:8042/`
+
+## Start the project for development without Docker
+1. Clone the repo and go to the project directory
+    ```shell
+    git clone git@github.com:Uma-Tech/parrot.git
+    cd parrot
+    ```
+
+1. Install dependencies
+    ```shell
+    poetry install
+    ```
+
+1. Start databases  
+    _You can start databases in any other way_
+   ```shell
+    # start postgres
+   docker run \
+       --name postgres \
+       -d \
+       --rm \
+       -e POSTGRES_PASSWORD=parrot \
+       -e POSTGRES_USER=parrot \
+       --network host \
+       -v parrot_db:/var/lib/postgresql/data \
+       postgres
+   
+    # start redis
+   docker run \
+       --name redis \
+       -d \
+       --rm \
+       --network host \
+       redis
+    ```
+
+1. Setting required environment variables  
+    ```shell
+    export PARROT_DB_HOST=127.0.0.1
+    export PARROT_SECRET_KEY=NO_SECRET
+    export PARROT_CELERY_BROKER_URL=redis://127.0.0.1
+    ```
+   _Alternatively, you can create a local `.env` file with the variables_
+
+1. Build static
+    ```shell
+    poetry run python manage.py collectstatic --no-input
+    ```
+
+1. Apply database migrations
+    ```shell
+    poetry run python manage.py migrate
+    ```
+
+1. Create a django superuser
+    ```shell
+    poetry run python manage.py createsuperuser
+    ```
+
+1. Start the django app
+    ```shell
+    poetry run python manage.py runserver
+    ```
+
+1. Start the celery worker  
+   _Run in a separate terminal window_
+    ```shell
+    poetry run celery -A parrot worker -l INFO -c 4
+    ```

docs/src/qs_system_requires.md → docs/src/quick-start/system-requires.md

@@ -6,3 +6,5 @@
 * make
     ([https://www.gnu.org/software/make/](https://www.gnu.org/software/make/))
     _(all commands can be viewed by calling `make` without parameters)_
+* poetry _(for development)_
+  ([https://python-poetry.org/](https://python-poetry.org/))