Update ghnav-flask example & README

README.rst

@@ -103,8 +103,8 @@ the application structure. It is **easy to understand and change** it.
         index_view = flask.View(
             views.index,
             search_service=search_service,
-            default_search_term=config.search.default_term,
-            default_search_limit=config.search.default_limit,
+            default_query=config.search.default_query,
+            default_limit=config.search.default_limit,
         )
 
 Running such container looks like this:

examples/miniapps/ghnav-flask/config.yml

@@ -1,5 +1,5 @@
 github:
   request_timeout: 10
 search:
-  default_term: "Dependency Injector"
+  default_query: "Dependency Injector"
   default_limit: 10

examples/miniapps/ghnav-flask/githubnavigator/containers.py

@@ -32,6 +32,6 @@ class ApplicationContainer(containers.DeclarativeContainer):
     index_view = flask.View(
         views.index,
         search_service=search_service,
-        default_search_term=config.search.default_term,
-        default_search_limit=config.search.default_limit,
+        default_query=config.search.default_query,
+        default_limit=config.search.default_limit,
     )

examples/miniapps/ghnav-flask/githubnavigator/services.py

@@ -11,10 +11,10 @@ class SearchService:
     def __init__(self, github_client: Github):
         self._github_client = github_client
 
-    def search_repositories(self, term, limit):
+    def search_repositories(self, query, limit):
         """Search for repositories and return formatted data."""
         repositories = self._github_client.search_repositories(
-            query=term,
+            query=query,
             **{'in': 'name'},
         )
         return [

examples/miniapps/ghnav-flask/githubnavigator/templates/index.html

@@ -8,12 +8,22 @@
 
     <form>
         <div class="form-group form-row">
-          <label for="search_term" class="col-form-label">Search for:</label>
             <div class="col-10">
-              <input class="form-control" type="text" id="search_term"
+                <label for="search_query" class="col-form-label">Search for:</label>
+                <input class="form-control" type="text" id="search_query"
                        placeholder="Type something to search on the GitHub"
-                     name="search_term"
-                     value="{{ search_term if search_term }}">
+                       name="query"
+                       value="{{ query if query }}">
+            </div>
+            <div class="col">
+                <label for="search_limit" class="col-form-label">Limit:</label>
+                <select class="form-control" id="search_limit" name="limit">
+                    {% for value in [5, 10, 20] %}
+                    <option {% if value == limit %}selected{% endif %}>
+                        {{ value }}
+                    </option>
+                    {% endfor %}
+                </select>
             </div>
         </div>
     </form>

examples/miniapps/ghnav-flask/githubnavigator/views.py

@@ -5,12 +5,19 @@ from flask import request, render_template
 from .services import SearchService
 
 
-def index(search_service: SearchService, default_search_term: str, default_search_limit: int):
-    search_term = request.args.get('search_term', default_search_term)
-    repositories = search_service.search_repositories(search_term, default_search_limit)
+def index(
+        search_service: SearchService,
+        default_query: str,
+        default_limit: int,
+):
+    query = request.args.get('query', default_query)
+    limit = request.args.get('limit', default_limit, int)
+
+    repositories = search_service.search_repositories(query, limit)
 
     return render_template(
         'index.html',
-        search_term=search_term,
+        query=query,
+        limit=limit,
         repositories=repositories,
     )