Improve work with deps

- reduced the number of optional libraries installed by default
- moved aiohttp to extras
- added an example of integrating the library into a fastapi project
- updated README.md
- updated Dockerfile used to run tests
- updated ci/cd configs

Author: aleksey925

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
       - "*"
 
 env:
-  POETRY_VERSION: "1.1.13"
+  POETRY_VERSION: "1.2.2"
 
 jobs:
   deploy:
@@ -19,11 +19,11 @@ jobs:
           python-version: "3.8"
       - name: Install poetry
         run: |
-          wget https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
+          wget -O get-poetry.py https://install.python-poetry.org
           python ./get-poetry.py --version $POETRY_VERSION
           echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --all-extras
         env:
           POETRY_VIRTUALENVS_CREATE: false
       - name: Release package

.github/workflows/test.yml

@@ -9,8 +9,8 @@ on:
       - 'master'
 
 env:
-  POETRY_VERSION: "1.1.13"
-  MIN_COVERAGE: "97"
+  POETRY_VERSION: "1.2.2"
+  MIN_COVERAGE: "99"
 
 jobs:
   lint:
@@ -23,11 +23,11 @@ jobs:
           python-version: "3.8"
       - name: Install poetry
         run: |
-          wget https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
+          wget -O get-poetry.py https://install.python-poetry.org
           python ./get-poetry.py --version $POETRY_VERSION
           echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --all-extras
         env:
           POETRY_VIRTUALENVS_CREATE: false
       - name: Run lint
@@ -51,11 +51,11 @@ jobs:
           python-version: "${{ matrix.py_version }}"
       - name: Install poetry
         run: |
-          wget https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py
+          wget -O get-poetry.py https://install.python-poetry.org
           python ./get-poetry.py --version $POETRY_VERSION
           echo "$HOME/.poetry/bin" >> $GITHUB_PATH
       - name: Install dependencies
-        run: poetry install
+        run: poetry install --all-extras
         env:
           POETRY_VIRTUALENVS_CREATE: false
       - name: Run tests

Dockerfile

@@ -2,14 +2,14 @@ ARG PYTHON_VERSION
 
 FROM python:${PYTHON_VERSION}-buster
 
-ENV POETRY_VERSION=1.1.13
+ENV POETRY_VERSION=1.2.2
 
 WORKDIR /opt/app/
 
 RUN apt update \
     && apt-get install -y wget \
-    && ln -s /root/.poetry/bin/poetry /usr/bin/poetry \
-    && wget https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py \
+    && ln -s /root/.local/bin/poetry /usr/bin/poetry \
+    && wget -O get-poetry.py https://install.python-poetry.org \
     && python ./get-poetry.py --version $POETRY_VERSION \
     && poetry config virtualenvs.create false \
     && rm ./get-poetry.py \
@@ -20,7 +20,9 @@ RUN apt update \
     && touch README.md
 
 COPY pyproject.toml poetry.lock /opt/app/
-RUN /bin/bash -c 'mkdir -p src/runtime_config && touch src/runtime_config/__init__.py && poetry install --no-interaction --no-ansi'
+RUN /bin/bash -c "mkdir -p src/runtime_config  \
+                  && touch src/runtime_config/__init__.py  \
+                  && poetry install --all-extras --no-interaction --no-ansi"
 
 COPY src/ /opt/app/src
 COPY tests/ /opt/app/tests

Makefile

@@ -1,4 +1,7 @@
 test:
+	pytest --cov="runtime_config" .
+
+test-multi-versions:
 	bash scripts/tests.sh
 
 lint:

README.md

@@ -30,21 +30,39 @@ Table of contents:
 
 # Installation
 
-This project can be installed using pip:
+You can install the library like this:
 
-```
-pip install runtime-config-py
-```
+- from pypi
+
+  ```
+  pip install runtime-config-py[aiohttp]
+  ```
+
+  or
 
-Or it can be installed directly from git:
+  ```
+  poetry add runtime-config-py -E aiohttp
+  ```
+
+- from git:
+
+  ```
+  pip install git+https://github.com/runtime-config/runtime-config-py.git#egg="runtime-config-py[aiohttp]"
+  ```
+
+
+Source dependencies have been moved to extras to give you more control over which libraries are installed. If you
+have a project dependency on a certain version of aiohttp you can install the library without specifying extras.
 
 ```
-pip install git+https://github.com/runtime-config/runtime-config-py.git
+pip install runtime-config-py
 ```
 
 # Usage
 
-Let's see a simple example of using this library together with aiohttp.
+Examples of using the library can be found [here](./example).
+
+Let's see a simple example of using this library together with aiohttp application.
 
 ```python
 from aiohttp import web
@@ -115,14 +133,27 @@ config = await RuntimeConfig.create(..., source=your_source)
 
 # Development
 
+## Install deps
+
+```
+poetry install --all-extras
+```
+
 ## Tests
 
 Check the work of the library on several versions of Python at once using the command below:
 
+```
+make test-multi-versions
+```
+
+The simple test run is available through the command below:
+
 ```
 make test
 ```
 
+
 ## Style code
 
 For automatic code formatting and code verification, you need to use the command below:

example/example-with-aiohttp/requirements.txt

@@ -1,2 +1 @@
-aiohttp==3.8.1
-git+https://github.com/runtime-config/runtime-config-py.git
+git+https://github.com/runtime-config/runtime-config-py.git#egg=runtime-config-py[aiohttp]

example/example-with-fastapi/main.py

@@ -0,0 +1,30 @@
+import uvicorn
+from fastapi import APIRouter, FastAPI
+
+from runtime_config import RuntimeConfig
+from runtime_config import get_instance as get_config_inst
+from runtime_config.sources import ConfigServerSrc
+
+router = APIRouter()
+
+
+@router.get("/")
+async def hello():
+    config = get_config_inst()
+    return f'Hello world {config.name}!'
+
+
+async def init() -> None:
+    source = ConfigServerSrc(host='http://127.0.0.1:8080', service_name='hello_world')
+    await RuntimeConfig.create(init_settings={'name': 'Alex'}, source=source)
+
+
+async def shutdown() -> None:
+    await get_config_inst().close()
+
+
+app = FastAPI()
+app.on_event("startup")(init)
+app.on_event("shutdown")(shutdown)
+app.include_router(router)
+uvicorn.run(app, port=5000)

example/example-with-fastapi/requirements.txt

@@ -0,0 +1,3 @@
+fastapi==0.85.1
+uvicorn==0.19.0
+git+https://github.com/runtime-config/runtime-config-py.git#egg=runtime-config-py[aiohttp]