clear-skies 2.0.0__tar.gz → 2.0.1__tar.gz

{clear_skies-2.0.0 → clear_skies-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: clear-skies
-Version: 2.0.0
+Version: 2.0.1
 Summary: A framework for building backends in the cloud
 License: MIT
 Author: Conor Mancone
@@ -25,7 +25,7 @@ Requires-Dist: pymysql (>=1.1.0,<2.0.0) ; extra == "mysql"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: typing-extensions (>=4.12.0,<5.0.0) ; python_version == "3.10"
 Requires-Dist: wrapt (>=1.16.0,<2.0.0)
-Project-URL: Repository, https://github.com/cmancone/clearskies
+Project-URL: Repository, https://github.com/clearskies-py/clearskies
 Description-Content-Type: text/markdown
 
 # clearskies

{clear_skies-2.0.0 → clear_skies-2.0.1}/pyproject.toml

@@ -10,7 +10,7 @@ requires-python = '>=3.11,<4.0'
 dependencies = ['dateparser (>=1.1.8,<2.0.0)', 'requests (>=2.31.0,<3.0.0)', 'typing-extensions (>=4.12.0,<5.0.0) ; python_version >= "3.10" and python_version < "3.11"', 'wrapt (>=1.16.0,<2.0.0)']
 
 [project.urls]
-repository = "https://github.com/cmancone/clearskies"
+repository = "https://github.com/clearskies-py/clearskies"
 
 [project.optional-dependencies]
 secrets = ['akeyless (>=4.0.0,<5.0.0)', 'akeyless-cloud-id (>=0.2.3,<0.3.0)']
@@ -24,7 +24,8 @@ packages = [
 exclude = [
     "src/clearskies/*_test.py",
     "src/clearskies/**/*_test.py",
-    "src/clearskies/integration_tests/*"
+    "src/clearskies/integration_tests/*",
+    "docs/**"
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -68,7 +69,8 @@ preview = true
 python_version = "3.11"
 
 exclude = [
- ".*_test\\.py$"
+ ".*_test\\.py$",
+ "docs/.*"
 ]
 
 [tool.poetry-git-version-plugin]

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/authentication/authentication.py

@@ -12,6 +12,10 @@ if TYPE_CHECKING:
 
 
 class Authentication(clearskies.configurable.Configurable, requests.auth.AuthBase):
+    """
+    Authentication!
+    """
+
     is_public = True
     can_authorize = False
     has_dynamic_credentials = False

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/authentication/authorization.py

@@ -1,4 +1,8 @@
 class Authorization:
+    """
+    Authorization!
+    """
+
     def gate(self, authorization_data, input_output):
         """
         Return True/False to denote if the given user, as represented by the authorization data, should be allowed access.

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/authentication/jwks.py

@@ -10,8 +10,13 @@ from clearskies.security_headers.cors import Cors
 
 
 class Jwks(Authentication, clearskies.di.InjectableProperties):
-    """The URL where the JWKS can be found."""
+    """
+    Validate a JWT against a JWKS (JSON Web Key Set)
+    """
 
+    """
+    The URL of the JWKS
+    """
     jwks_url = clearskies.configs.String(required=True)
 
     """

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/authentication/secret_bearer.py

@@ -495,7 +495,7 @@ class SecretBearer(Authentication, clearskies.di.InjectableProperties):
         if not self._alternate_secret:
             self._alternate_secret = (
                 self.secrets.get(self.alternate_secret_key)
-                if self.secret_key
+                if self.alternate_secret_key
                 else self.environment.get(self.alternate_environment_key)
             )
         return self._alternate_secret

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/backends/backend.py

@@ -9,6 +9,19 @@ from clearskies.autodoc.schema import Schema as AutoDocSchema
 
 
 class Backend(ABC):
+    """
+    Conecting models to their data since 2020!
+
+    The backend system acts as a flexible layer between models and their data sources.  By changing the backend attached to a model,
+    you change where the model fetches and saves data.  This might be a database, an in-memory data store, a dynamodb table,
+    an API, and more.  This allows you to interact with a variety of data sources with the models acting as a standardized API.
+    Since endpoints also rely on the models for their functionality, this means that you can easily build API endpoints and
+    more for a variety of data sources with a minimal amount of code.
+
+    Of course, not all data sources support all functionality present in the model.  Therefore, you do still need to have
+    a fair understanding of how your data sources work.
+    """
+
     supports_n_plus_one = False
     can_count = True
 

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/column.py

@@ -24,13 +24,10 @@ if TYPE_CHECKING:
 
 class Column(clearskies.configurable.Configurable, clearskies.di.InjectableProperties):
     """
-    The base column.
+    Columns are used to build schemes and enable a variety of levels of automation with clearskies.
 
-    This class (well, the children that extend it) are used to define the columns that exist in a given model class -
-    they help you build your schema.  The column definitions are then used by handlers and other aspects of the
-    clearskies framework to automate things like input validation, front-end/backend-transformations, and more.
-    Many column classes have their own configuration settings, but there are also some common configuration settings
-    defined here.
+    Columns are used to define your schemas in clearskies, especially via models.  The column definitions are then used by endpoints
+    and other aspects of the clearskies framework to automate things like input validation, front-end/backend-transformations, and more.
     """
 
     """

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/configs/__init__.py

@@ -80,6 +80,7 @@ from .config import Config
 from .datetime import Datetime
 from .datetime_or_callable import DatetimeOrCallable
 from .endpoint import Endpoint
+from .endpoint_list import EndpointList
 from .float import Float
 from .float_or_callable import FloatOrCallable
 from .integer import Integer
@@ -126,6 +127,8 @@ __all__ = [
     "Config",
     "Datetime",
     "DatetimeOrCallable",
+    "Endpoint",
+    "EndpointList",
     "Float",
     "FloatOrCallable",
     "Joins",

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/configs/config.py

@@ -1,5 +1,8 @@
+from typing import Any
+
+
 class Config:
-    def __init__(self, required=False, default=None):
+    def __init__(self, required: bool = False, default: Any = None):
         self.required = required
         self.default = default
 

clear_skies-2.0.1/src/clearskies/configs/endpoint_list.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from clearskies.configs import config
+
+if TYPE_CHECKING:
+    from clearskies.endpoint import Endpoint as EndpointBase
+
+
+class EndpointList(config.Config):
+    def __set__(self, instance, value: list[EndpointBase]):
+        if not isinstance(value, list):
+            raise TypeError(
+                f"{error_prefix} attempt to set a value of type '{value.__class__.__name__}' to a parameter that requries a list of endpoints."
+            )
+        for index, item in enumerate(value):
+            if not hasattr(item, "top_level_authentication_and_authorization"):
+                error_prefix = self._error_prefix(instance)
+                raise TypeError(
+                    f"{error_prefix} attempt to set a value of type '{item.__class__.__name__}' for item #{index+1} when all items in the list should be instances of clearskies.End."
+                )
+        instance._set_config(self, value)
+
+    def __get__(self, instance, parent) -> list[EndpointBase]:
+        if not instance:
+            return self  # type: ignore
+        return instance._get_config(self)

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/contexts/cli.py

@@ -3,5 +3,9 @@ from clearskies.input_outputs import Cli as CliInputOutput
 
 
 class Cli(Context):
+    """
+    Run an application via a CLI command
+    """
+
     def __call__(self):  # type: ignore
         return self.execute_application(CliInputOutput())

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/contexts/context.py

@@ -15,8 +15,21 @@ if TYPE_CHECKING:
 
 
 class Context:
+    """
+    Context: a flexible way to connect applications to hosting strategies.
+    """
+
     di: Di = None  # type: ignore
 
+    """
+    The application to execute.
+
+    This can be a callable, an endpoint, or an endpoint group.  If passed a callable, the callable can request any
+    standard or defined dependencies and should return the desired response.  It can also raise any exception from
+    clearskies.exceptions.
+    """
+    application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup = None  # type: ignore
+
     def __init__(
         self,
         application: Callable | clearskies.endpoint.Endpoint | clearskies.endpoint_group.EndpointGroup,

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/contexts/wsgi.py

@@ -12,5 +12,9 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class Wsgi(Context):
+    """
+    Connect your application to a WSGI server.
+    """
+
     def __call__(self, env, start_response):  # type: ignore
         return self.execute_application(WsgiInputOutput(env, start_response))

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/contexts/wsgi_ref.py

@@ -12,6 +12,10 @@ from clearskies.input_outputs import Wsgi as WsgiInputOutput
 
 
 class WsgiRef(Context):
+    """
+    Use a built in WSGI server (for development purposes only).
+    """
+
     port: int = 8080
 
     def __init__(

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/di/di.py

@@ -23,7 +23,7 @@ class Di:
     Build a dependency injection object.
 
     The dependency injection (DI) container is a key part of clearskies, so understanding how to both configure
-    them and get dependencies for your classes is important.  Note however that there you don't often have
+    them and get dependencies for your classes is important.  Note however that you don't often have
     to interact with the dependency injection container directly.  All of the configuration options for
     the DI container are also available to all the contexts, which is typically how you will build clearskies
     applications.  So, while you can create a DI container and use it directly, typically you'll just follow
@@ -648,7 +648,7 @@ class Di:
         its name and type-hint.
         """
         built_value = self.build_class_from_type_hint(argument_name, type_hint, context=context, cache=True)
-        if built_value:
+        if built_value is not None:
             return built_value
         return self.build_from_name(argument_name, context=context, cache=True)
 

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/endpoint.py

@@ -32,15 +32,16 @@ class Endpoint(
     clearskies.di.InjectableProperties,
 ):
     """
-    Endpoints - the clearskies workhorse.
+    Automating drudgery!
 
     With clearskies, endpoints exist to offload some drudgery and make your life easier, but they can also
     get out of your way when you don't need them.  Think of them as pre-built endpoints that can execute
     common functionality needed for web applications/APIs.  Instead of defining a function that fetches
     records from your backend and returns them to the end user, you can let the list endpoint do this for you
     with a minimal amount of configuration.  Instead of making an endpoint that creates records, just deploy
-    a create endpoint.  Each endpoint has their own configuration settings, but there are some configuration
-    settings that are common to all endpoints, which are listed below:
+    a create endpoint.  While this gives clearskies some helpful capabiltiies for automation, it also has
+    the Callable endpoint which simply calls a developer-defined function, and therefore allows clearskies to
+    act like a much more typical framework.
     """
 
     """
@@ -342,7 +343,7 @@ class Endpoint(
     """
     The model class used by this endpoint.
 
-    The majority of endpoints require a model class that tells the endpoint where to get/save its data.
+    The endpoint will use this to fetch/save/validate incoming data as needed.
     """
     model_class = clearskies.configs.ModelClass(default=None)
 

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/endpoint_group.py

@@ -217,11 +217,24 @@ class EndpointGroup(
     The dependency injection container
     """
     di = clearskies.di.inject.Di()
+
+    """
+    The base URL for the endpoint group.
+
+    This URL is added as a prefix to all endpoints attached to the group.  This includes any named URL parameters:
+    """
     url = clearskies.configs.String(default="")
+
+    """
+    The list of endpoints connected to this endpoint group
+    """
+    endpoints = clearskies.configs.EndpointList()
+
     response_headers = clearskies.configs.StringListOrCallable(default=[])
     authentication = clearskies.configs.Authentication(default=Public())
     authorization = clearskies.configs.Authorization(default=Authorization())
     security_headers = clearskies.configs.SecurityHeaders(default=[])
+
     cors_header: SecurityHeader = None  # type: ignore
     has_cors: bool = False
     endpoints_initialized = False

{clear_skies-2.0.0 → clear_skies-2.0.1}/src/clearskies/endpoints/callable.py

@@ -23,13 +23,13 @@ class Callable(Endpoint):
     """
     An endpoint that executes a user-defined function.
 
-    The Callable endpoint does exactly that - you provide a function that will be called when the endpoin is invoked.  Like
-    all callables invoked by clearskies, you can request any defined depenndency that can be provided by the clearskies
+    The Callable endpoint does exactly that - you provide a function that will be called when the endpoint is invoked.  Like
+    all callables invoked by clearskies, you can request any defined dependency that can be provided by the clearskies
     framework.
 
     Whatever you return will be returned to the client.  By default, the return value is sent along in the `data` parameter
     of the standard clearskies response.  To suppress this behavior, set `return_standard_response` to `False`.  You can also
-    return an model instance, a model query, or a list of model instances and the callable endpoint will automatically return
+    return a model instance, a model query, or a list of model instances and the callable endpoint will automatically return
     the columns specified in `readable_column_names` to the client.
 
     Here's a basic working example:
@@ -300,6 +300,7 @@ class Callable(Endpoint):
                     converted_models,
                     number_results=len(response) if response.backend.can_count else None,
                     next_page=response.next_page_data(),
+                    limit=response.get_query().limit,
                 )
 
         # or did they return a list of models?