Rewrote some docs and added docs on modulesetup and dynamic setup

Author: eadwinCode

README.md

@@ -40,19 +40,15 @@ If you are familiar with these frameworks, you will find it easy to understand a
 ## Installation
 ### Poetry Installation
 For [Poetry](https://python-poetry.org/) usages
+
 ```shell
-poetry add ellar[standard]
+poetry add ellar-cli
 ```
 
 ### Pip Installation
 For normal pip installation
 ```shell
-pip install ellar[standard]
-```
-### NB:
-Some shells may treat square braces (`[` and `]`) as special characters. If that's the case here, then use a quote around the characters to prevent unexpected shell expansion.
-```shell
-pip install "ellar[standard]"
+pip install ellar-cli
 ```
 
 ## Create a project
@@ -234,7 +230,6 @@ Ellar is not aware of `CarModule` yet, so we need to add it to the `modules` lis
 ```python
 from ellar.common import Module, exception_handler
 from ellar.core import IHostContext, ModuleBase
-from ellar.core.connection import Request
 from ellar.core.response import JSONResponse, Response
 
 from ellar.samples.modules import HomeModule

mkdocs.yml

@@ -4,12 +4,25 @@ site_url: https://github.com/eadwinCode/ellar
 repo_name: eadwinCode/ellar
 repo_url: https://github.com/eadwinCode/ellar
 edit_uri: blob/master/docs
+copyright: |
+  Copyright &copy; 2021 - 2023 <a href="https://github.com/eadwinCode"  target="_blank" rel="noopener">Eadwin Ezeudoh</a>
 
 docs_dir: docs
 site_dir: site
 
 theme:
   name: material
+  features:
+    - announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -26,15 +39,22 @@ theme:
       toggle:
         icon: material/lightbulb-outline
         name: Switch to light mode
-
+  font:
+    text: Roboto
+    code: Roboto Mono
   language: en
   logo: img/Icon.svg
   favicon: img/Icon.svg
   icon:
     repo: fontawesome/brands/git-alt
 
 plugins:
-- search
+  - search:
+        separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - minify:
+        minify_html: true
+  - git-revision-date-localized:
+      enable_creation_date: false
 
 nav:
   - Introduction: index.md
@@ -45,7 +65,7 @@ nav:
       - Modules:  overview/modules.md
       - Middlewares:  overview/middleware.md
       - Exception Handling:  overview/exception_handling.md
-#      - Guards:  overview/guards.md
+      - Guards:  overview/guards.md
       - Custom Decorators:  overview/custom_decorators.md
       - Module Router:  overview/module-router.md
   - Configuration: configurations.md
@@ -66,11 +86,20 @@ nav:
     - Static Files: templating/staticfiles.md
 
   - Caching: caching.md
+  - Rate Limiting: throttling.md
 #  - Injection Scopes: basics/injection-scope.md
 #  - Model View Controller: basics/model-view-controller.md
 #  - Events: basics/events.md
+  - Commands:
+    - Introduction: commands/index.md
+    - Commands:
+        - new: commands/new-command.md
+        - create project: commands/create-project-command.md
+        - create module: commands/create-module-command.md
+        - runserver: commands/runserver-command.md
+    - Custom Commands: commands/custom-commands.md
+    - Command Grouping: commands/command-grouping.md
   - Versioning: basics/versioning.md
-  - Commands: basics/commands.md
   - Testing: basics/testing.md
   - OpenAPI: openapi/index.md
   - WebSockets: websockets.md
@@ -93,7 +122,6 @@ markdown_extensions:
       custom_fences:
       - name: mermaid
         class: mermaid
-        format: !!python/name:pymdownx.superfences.fence_code_format ''
   - pymdownx.details
   - pymdownx.tabbed:
       alternate_style: true

tests/test_application/test_application_functions.py

@@ -126,7 +126,6 @@ def run_cleanup():
         app = App(
             config=Config(),
             injector=EllarInjector(),
-            routes=[],
             on_startup_event_handlers=[EventHandler(run_startup)],
             on_shutdown_event_handlers=[EventHandler(run_cleanup)],
         )
@@ -150,9 +149,7 @@ async def lifespan(app):
             yield
             cleanup_complete = True
 
-        app = App(
-            config=Config(), injector=EllarInjector(), lifespan=lifespan, routes=[]
-        )
+        app = App(config=Config(), injector=EllarInjector(), lifespan=lifespan)
 
         assert not startup_complete
         assert not cleanup_complete
@@ -217,7 +214,7 @@ def test_app_staticfiles_route(self, tmpdir):
         injector = EllarInjector()
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(injector=injector, config=config, routes=[])
+        app = App(injector=injector, config=config)
         client = TestClient(app)
 
         response = client.get("/static/example.txt")
@@ -239,7 +236,7 @@ def test_app_staticfiles_with_different_static_path(self, tmpdir):
         injector = EllarInjector()
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(injector=injector, config=config, routes=[])
+        app = App(injector=injector, config=config)
         client = TestClient(app)
 
         response = client.get("/static-modified/example.txt")
@@ -258,15 +255,15 @@ def test_app_install_module(self):
         assert module_instance is module_instance2
 
     def test_has_static_files(self, tmpdir):
-        app = App(injector=EllarInjector(), config=Config(), routes=[])
+        app = App(injector=EllarInjector(), config=Config())
         assert app.has_static_files is False
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config, routes=[])
+        app = App(injector=EllarInjector(), config=config)
         assert app.has_static_files
 
     def test_app_enable_versioning_and_versioning_scheme(self):
-        app = App(injector=EllarInjector(), config=Config(), routes=[])
+        app = App(injector=EllarInjector(), config=Config())
         assert app.config.VERSIONING_SCHEME
         assert isinstance(app.config.VERSIONING_SCHEME, DefaultAPIVersioning)
 
@@ -290,7 +287,7 @@ def test_app_initialization_completion(self):
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
 
-        app = App(config=config, injector=injector, routes=[])
+        app = App(config=config, injector=injector)
         assert injector.get(Reflector)
         assert injector.get(Config) is config
         assert injector.get(Environment) is app.jinja_environment
@@ -313,7 +310,7 @@ async def catch(
         )  # will raise an exception is service is not registered
         CoreServiceRegistration(injector, config=Config()).register_all()
         injector.container.register_instance(config)
-        app = App(config=config, injector=injector, routes=[])
+        app = App(config=config, injector=injector)
         app.add_exception_handler(CustomExceptionHandler())
 
         @get("/404")
@@ -364,7 +361,7 @@ def test_app_create_static_app(self, tmpdir):
             file.write("<file content>")
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config, routes=[])
+        app = App(injector=EllarInjector(), config=config)
         static_app = app.create_static_app()
         assert isinstance(static_app, StaticFiles)
         client = TestClient(static_app)
@@ -386,7 +383,7 @@ def test_app_reload_static_app(self, tmpdir):
             file.write("<file content>")
 
         config = Config(STATIC_DIRECTORIES=[tmpdir])
-        app = App(injector=EllarInjector(), config=config, routes=[])
+        app = App(injector=EllarInjector(), config=config)
         static_app_old = app._static_app
 
         app.reload_static_app()
@@ -399,7 +396,7 @@ def test_app_reload_static_app(self, tmpdir):
         assert res.text == "<file content>"
 
     def test_app_template_filter(self):
-        app = App(injector=EllarInjector(), config=Config(), routes=[])
+        app = App(injector=EllarInjector(), config=Config())
 
         @app.template_filter()
         def square(value):
@@ -424,7 +421,7 @@ def triple_function(value):
         assert result == "<html>filter square: 4, filter triple_function: 27</html>"
 
     def test_app_template_global(self):
-        app = App(injector=EllarInjector(), config=Config(), routes=[])
+        app = App(injector=EllarInjector(), config=Config())
 
         @app.template_global()
         def square(value):

tests/test_di/test_provider_scopes.py

@@ -53,6 +53,33 @@ def test_invalid_use_of_provider_config():
         ProviderConfig(IContext, use_class=AnyContext, use_value=AnyContext())
 
 
+def test_provider_config_use_value():
+    injector = EllarInjector(auto_bind=False)
+    ProviderConfig(IContext, use_value=AnyContext()).register(injector.container)
+
+    # IContext is now registered as a singleton
+    assert injector.get(IContext) == injector.get(IContext)
+
+
+def test_provider_config():
+    injector = EllarInjector(auto_bind=False)
+    ProviderConfig(AnyContext).register(injector.container)
+
+    assert injector.get(AnyContext) != injector.get(AnyContext)  # RequestScope
+
+
+def test_invalid_use_provider_config():
+    injector = EllarInjector(auto_bind=False)
+    any_ctx = AnyContext()
+    with pytest.raises(DIImproperConfiguration) as ex:
+        ProviderConfig(any_ctx).register(injector.container)
+
+    assert (
+        str(ex.value)
+        == f"couldn't determine provider setup for {any_ctx}. Please use `ProviderConfig` or `register_services` function in a Module to configure the provider"
+    )
+
+
 def test_has_binding_works():
     @inject
     def inject_function(a: IContext):