Restore the name guardpost 🔤

RobertoPrevato · web-flow · commit 4b1e33c870a4 · 2023-01-07T21:52:14.000+01:00
See Neoteroi/BlackSheep#299
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,7 +12,7 @@ on:
       - "*"
 
 env:
-  PROJECT_NAME: neoteroi
+  PROJECT_NAME: guardpost
 
 jobs:
   build:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,13 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0] - 2022-12-xx :star:
-- Renames the library to `neoteroi-auth`.
-- Adopts PEP 420 and renames the main namespace from `guardpost` to `neoteroi.auth`
+## [1.0.0] - 2023-01-07 :star:
 - Adds built-in support for dependency injection, using the new `ContainerProtocol`
-  in `neoteroi-di` (new version of `rodi`).
+  in `rodi` v2.
 - Removes the synchronous code API, maintaining only the asynchronous code API
-  for `AuthenticationStrategy.authenticate` and `AuthorizationStrategy.authorize`.
+  for `AuthenticationStrategy.authenticate` and `AuthoreoizationStrategy.authorize`.
 - Replaces `setup.py` with `pyproject.toml`.
 - Reduces imports verbosity.
 - Improves the `identity_getter` code API.
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@
 
 
 lint-types:
-	mypy neoteroi --explicit-package-bases
+	mypy guardpost --explicit-package-bases
 
 
 artifacts: test
@@ -34,30 +34,30 @@ test:
 
 
 test-cov:
-	python -m pytest --cov-report html --cov=neoteroi tests/
+	python -m pytest --cov-report html --cov=guardpost tests/
 
 
 lint: check-flake8 check-isort check-black
 
 format:
-	@isort neoteroi 2>&1
+	@isort guardpost 2>&1
 	@isort tests 2>&1
-	@black neoteroi 2>&1
+	@black guardpost 2>&1
 	@black tests 2>&1
 
 check-flake8:
 	@echo "$(BOLD)Checking flake8$(RESET)"
-	@flake8 neoteroi 2>&1
+	@flake8 guardpost 2>&1
 	@flake8 tests 2>&1
 
 
 check-isort:
 	@echo "$(BOLD)Checking isort$(RESET)"
-	@isort --check-only neoteroi 2>&1
+	@isort --check-only guardpost 2>&1
 	@isort --check-only tests 2>&1
 
 
 check-black:  ## Run the black tool in check mode only (won't modify files)
 	@echo "$(BOLD)Checking black$(RESET)"
-	@black --check neoteroi 2>&1
+	@black --check guardpost 2>&1
 	@black --check tests 2>&1
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 [![Build](https://github.com/Neoteroi/guardpost/workflows/Build/badge.svg)](https://github.com/Neoteroi/guardpost/actions?query=workflow%3ABuild)
-[![pypi](https://img.shields.io/pypi/v/neoteroi-auth.svg?color=blue)](https://pypi.org/project/neoteroi-auth/)
-[![versions](https://img.shields.io/pypi/pyversions/neoteroi-auth.svg)](https://github.com/Neoteroi/guardpost)
+[![pypi](https://img.shields.io/pypi/v/guardpost.svg?color=blue)](https://pypi.org/project/guardpost/)
+[![versions](https://img.shields.io/pypi/pyversions/guardpost.svg)](https://github.com/Neoteroi/guardpost)
 [![license](https://img.shields.io/github/license/Neoteroi/guardpost.svg)](https://github.com/Neoteroi/guardpost/blob/main/LICENSE)
 [![codecov](https://codecov.io/gh/Neoteroi/guardpost/branch/main/graph/badge.svg?token=sBKZG2D1bZ)](https://codecov.io/gh/Neoteroi/guardpost)
 
@@ -23,13 +23,13 @@ although its implementation is extremely different.
 ## Installation
 
 ```bash
-pip install neoteroi-auth
+pip install guardpost
 ```
 
 To install with support for `JSON Web Tokens (JWTs)` validation:
 
 ```
-pip install neoteroi-auth[jwt]
+pip install guardpost[jwt]
 ```
 
 ### Examples
@@ -48,13 +48,12 @@ Usually, to implement authorization, is necessary to have the context of the
 entity that is executing the action.
 
 ## Usage in BlackSheep
-`neoteroi-auth` is used in the second version of the
-[BlackSheep](https://www.neoteroi.dev/blacksheep/) web framework, to implement
-[authentication and authorization
+`guardpost` is used in the [BlackSheep](https://www.neoteroi.dev/blacksheep/)
+web framework, to implement [authentication and authorization
 strategies](https://www.neoteroi.dev/blacksheep/authentication/) for request
 handlers.
 
-To see how `neoteroi-auth` is used in `blacksheep` web framework, read:
+To see how `guardpost` is used in `blacksheep` web framework, read:
 
 * [Authentication](https://www.neoteroi.dev/blacksheep/authentication/)
 * [Authorization](https://www.neoteroi.dev/blacksheep/authorization/)
diff --git a/examples/example-01.py b/examples/example-01.py
@@ -4,7 +4,7 @@
 """
 import asyncio
 
-from neoteroi.auth import AuthenticationHandler, AuthenticationStrategy, Identity
+from guardpost import AuthenticationHandler, AuthenticationStrategy, Identity
 
 
 class MyAppContext:
diff --git a/examples/example-02.py b/examples/example-02.py
@@ -4,7 +4,7 @@
 """
 import asyncio
 
-from neoteroi.auth import AuthenticationHandler, AuthenticationStrategy, Identity
+from guardpost import AuthenticationHandler, AuthenticationStrategy, Identity
 
 
 class MyAppContext:
diff --git a/examples/example-03.py b/examples/example-03.py
@@ -4,7 +4,7 @@
 """
 import asyncio
 
-from neoteroi.auth import AuthenticationHandler, AuthenticationStrategy, Identity
+from guardpost import AuthenticationHandler, AuthenticationStrategy, Identity
 
 
 class MyAppContext:
diff --git a/examples/example-04.py b/examples/example-04.py
@@ -4,9 +4,9 @@
 """
 import asyncio
 
-from neoteroi.di import Container
+from rodi import Container
 
-from neoteroi.auth import AuthenticationHandler, AuthenticationStrategy, Identity
+from guardpost import AuthenticationHandler, AuthenticationStrategy, Identity
 
 
 class MyAppContext:
diff --git a/examples/example-05.py b/examples/example-05.py
@@ -5,7 +5,7 @@
 
 import asyncio
 
-from neoteroi.auth import (
+from guardpost import (
     AuthorizationContext,
     AuthorizationError,
     AuthorizationStrategy,
diff --git a/examples/example-06.py b/examples/example-06.py
@@ -7,15 +7,15 @@
 
 import asyncio
 
-from neoteroi.auth import (
+from guardpost import (
     AuthorizationContext,
     AuthorizationError,
     AuthorizationStrategy,
     Identity,
     Policy,
     Requirement,
 )
-from neoteroi.auth.common import AuthenticatedRequirement
+from guardpost.common import AuthenticatedRequirement
 
 
 class MyAppContext:
diff --git a/examples/example-07.py b/examples/example-07.py
@@ -6,9 +6,9 @@
 
 import asyncio
 
-from neoteroi.di import Container
+from rodi import Container
 
-from neoteroi.auth import (
+from guardpost import (
     AuthorizationContext,
     AuthorizationError,
     AuthorizationStrategy,
@@ -45,7 +45,7 @@ async def main():
 
     # NOTE: the following classes are registered as transient services - therefore
     # they are instantiated each time they are necessary.
-    # Refer to neoteroi-di documentation to know how to register singletons and scoped
+    # Refer to rodi documentation to know how to register singletons and scoped
     # services.
     container.register(Foo)
     container.register(MyInjectedRequirement)
diff --git a/guardpost.code-workspace b/guardpost.code-workspace
diff --git a/guardpost/__about__.py b/guardpost/__about__.py
@@ -0,0 +1 @@
+__version__ = "1.0.0"
diff --git a/guardpost/__init__.py b/guardpost/__init__.py
diff --git a/guardpost/abc.py b/guardpost/abc.py
@@ -1,7 +1,7 @@
 from abc import ABC
 from typing import Any, Iterable, List, Optional, Type, TypeVar, Union
 
-from neoteroi.di import ContainerProtocol
+from rodi import ContainerProtocol
 
 T = TypeVar("T")
 
diff --git a/guardpost/authentication.py b/guardpost/authentication.py
@@ -3,9 +3,9 @@
 from functools import lru_cache
 from typing import Any, List, Optional, Sequence, Type, Union
 
-from neoteroi.di import ContainerProtocol
+from rodi import ContainerProtocol
 
-from neoteroi.auth.abc import BaseStrategy
+from guardpost.abc import BaseStrategy
 
 
 class Identity:
diff --git a/guardpost/authorization.py b/guardpost/authorization.py
@@ -3,10 +3,10 @@
 from functools import lru_cache, wraps
 from typing import Any, Callable, Iterable, List, Optional, Sequence, Set, Type, Union
 
-from neoteroi.di import ContainerProtocol
+from rodi import ContainerProtocol
 
-from neoteroi.auth.abc import BaseStrategy
-from neoteroi.auth.authentication import Identity
+from guardpost.abc import BaseStrategy
+from guardpost.authentication import Identity
 
 
 class AuthorizationError(Exception):
diff --git a/guardpost/common.py b/guardpost/common.py
diff --git a/guardpost/errors.py b/guardpost/errors.py
diff --git a/guardpost/jwks/__init__.py b/guardpost/jwks/__init__.py
@@ -8,7 +8,7 @@
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric.rsa import RSAPublicNumbers
 
-from neoteroi.auth.errors import UnsupportedFeatureError
+from guardpost.errors import UnsupportedFeatureError
 
 
 def _raise_if_missing(value: dict, *keys: str) -> None:
diff --git a/guardpost/jwks/caching.py b/guardpost/jwks/caching.py
diff --git a/guardpost/jwks/openid.py b/guardpost/jwks/openid.py
@@ -1,4 +1,4 @@
-from neoteroi.auth.utils import get_running_loop, read_json_data
+from guardpost.utils import get_running_loop, read_json_data
 
 from . import JWKS, KeysProvider
 
diff --git a/guardpost/jwks/urls.py b/guardpost/jwks/urls.py
@@ -1,4 +1,4 @@
-from neoteroi.auth.utils import get_running_loop, read_json_data
+from guardpost.utils import get_running_loop, read_json_data
 
 from . import JWKS, KeysProvider
 
diff --git a/guardpost/jwts/__init__.py b/guardpost/jwts/__init__.py
diff --git a/guardpost/py.typed b/guardpost/py.typed
diff --git a/guardpost/utils.py b/guardpost/utils.py
diff --git a/neoteroi/auth/__about__.py b/neoteroi/auth/__about__.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "neoteroi-auth"
+name = "guardpost"
 dynamic = ["version"]
 authors = [
     { name = "Roberto Prevato", email = "roberto.prevato@gmail.com" },
@@ -24,7 +24,7 @@ classifiers = [
 ]
 keywords = ["authentication", "authorization", "identity", "claims", "strategy"]
 dependencies = [
-    "neoteroi-di<=2.0.0",
+    "rodi>=2.0.0",
     "typing_extensions; python_version < '3.8'",
 ]
 
@@ -49,14 +49,14 @@ exclude = [
   ".gitignore",
   ".flake8",
   "junit",
-  "neoteroi-auth.code-workspace",
+  "guardpost.code-workspace",
   "requirements.txt",
   "examples-summary.py"
 ]
 
 [tool.hatch.version]
-path = "neoteroi/auth/__about__.py"
+path = "guardpost/__about__.py"
 
 [project.urls]
-"Homepage" = "https://github.com/Neoteroi/auth"
-"Bug Tracker" = "https://github.com/Neoteroi/auth/issues"
+"Homepage" = "https://github.com/Neoteroi/GuardPost"
+"Bug Tracker" = "https://github.com/Neoteroi/GuardPost/issues"
diff --git a/requirements.txt b/requirements.txt
@@ -7,4 +7,4 @@ isort
 cryptography
 black
 flask
-neoteroi-di
+rodi>=2.0.0
diff --git a/tests/examples.py b/tests/examples.py
@@ -1,4 +1,4 @@
-from neoteroi.auth.authorization import AuthorizationContext, Requirement
+from guardpost.authorization import AuthorizationContext, Requirement
 
 
 class Request:
diff --git a/tests/serverfixtures.py b/tests/serverfixtures.py
@@ -7,7 +7,7 @@
 import pytest
 from flask import Flask
 
-from neoteroi.auth.jwks import JWKS
+from guardpost.jwks import JWKS
 
 SERVER_PORT = 44777
 BASE_URL = f"http://127.0.0.1:{SERVER_PORT}"
diff --git a/tests/test_authentication.py b/tests/test_authentication.py
@@ -2,10 +2,10 @@
 from uuid import uuid4
 
 import pytest
-from neoteroi.di import Container
 from pytest import raises
+from rodi import Container
 
-from neoteroi.auth.authentication import (
+from guardpost.authentication import (
     AuthenticationHandler,
     AuthenticationSchemesNotFound,
     AuthenticationStrategy,
diff --git a/tests/test_authorization.py b/tests/test_authorization.py
@@ -1,19 +1,19 @@
 from typing import Sequence
 
 import pytest
-from neoteroi.di import Container
 from pytest import raises
+from rodi import Container
 
-from neoteroi.auth.authentication import Identity, User
-from neoteroi.auth.authorization import (
+from guardpost.authentication import Identity, User
+from guardpost.authorization import (
     AuthorizationContext,
     AuthorizationStrategy,
     Policy,
     PolicyNotFoundError,
     Requirement,
     UnauthorizedError,
 )
-from neoteroi.auth.common import AuthenticatedRequirement, ClaimsRequirement
+from guardpost.common import AuthenticatedRequirement, ClaimsRequirement
 from tests.examples import NoopRequirement
 
 
diff --git a/tests/test_common.py b/tests/test_common.py
@@ -1,17 +1,17 @@
 from typing import Any, Optional
 
 import pytest
-from neoteroi.di import Container
 from pytest import raises
+from rodi import Container
 
-from neoteroi.auth.abc import DINotConfiguredError
-from neoteroi.auth.authentication import (
+from guardpost.abc import DINotConfiguredError
+from guardpost.authentication import (
     AuthenticationHandler,
     AuthenticationStrategy,
     Identity,
 )
-from neoteroi.auth.authorization import AuthorizationStrategy, Policy, UnauthorizedError
-from neoteroi.auth.common import AnonymousPolicy, AuthenticatedRequirement
+from guardpost.authorization import AuthorizationStrategy, Policy, UnauthorizedError
+from guardpost.common import AnonymousPolicy, AuthenticatedRequirement
 
 
 @pytest.mark.asyncio
@@ -174,4 +174,4 @@ def test_container_getter_raises_for_missing_container():
 
 
 def test_import_version():
-    from neoteroi.auth.__about__ import __version__  # noqa
+    from guardpost.__about__ import __version__  # noqa
diff --git a/tests/test_jwks.py b/tests/test_jwks.py
@@ -1,7 +1,7 @@
 import pytest
 
-from neoteroi.auth.errors import UnsupportedFeatureError
-from neoteroi.auth.jwks import JWK, JWKS, KeyType
+from guardpost.errors import UnsupportedFeatureError
+from guardpost.jwks import JWK, JWKS, KeyType
 
 
 def test_keytype_from_str():
diff --git a/tests/test_jwts.py b/tests/test_jwts.py
