diff --git a/.github/workflows/CICD-scripts/pyproject_dependency_rewrite.py b/.github/workflows/CICD-scripts/pyproject_dependency_rewrite.py
index 26fa2069..2ffd4df0 100755
--- a/.github/workflows/CICD-scripts/pyproject_dependency_rewrite.py
+++ b/.github/workflows/CICD-scripts/pyproject_dependency_rewrite.py
@@ -13,21 +13,21 @@
import toml
-# Import BL_Python.programming.cli.argparse.
+# Import Ligare.programming.cli.argparse.
# This must be done this way as this script is not used within an
-# environment in which BL_Python has been installed, and so
+# environment in which Ligare has been installed, and so
# the modules cannot be imported the usual way.
-programming_module_name = "BL_Python.programming.cli.argparse"
+programming_module_name = "Ligare.programming.cli.argparse"
module_path = Path(
Path(__file__).parent,
- "../../../src/programming/BL_Python/programming/cli/argparse.py",
+ "../../../src/programming/Ligare/programming/cli/argparse.py",
)
spec = importlib.util.spec_from_file_location(programming_module_name, str(module_path))
if spec is None or not spec.loader:
raise Exception(f"Could not find module `{programming_module_name}`.")
-BL_Python_argparse = importlib.util.module_from_spec(spec)
-sys.modules[programming_module_name] = BL_Python_argparse
-spec.loader.exec_module(BL_Python_argparse)
+Ligare_argparse = importlib.util.module_from_spec(spec)
+sys.modules[programming_module_name] = Ligare_argparse
+spec.loader.exec_module(Ligare_argparse)
# finish import
@@ -50,13 +50,13 @@ class RewriteArgs(Namespace):
"-c",
"--config",
type=Path,
- action=BL_Python_argparse.PathExists,
+ action=Ligare_argparse.PathExists,
help="The path to the pyproject.toml file to rewrite. If not specified, all pyproject.toml under src/*/pyproject.toml, and pyproject.toml will be processed.",
required=False,
)
args = parser.parse_args(namespace=RewriteArgs)
-BL_PYTHON = "BL_Python"
+LIGARE = "Ligare"
WORKFLOW_DISPATCH_REWRITE_DEPENDENCIES = environ.get("REWRITE_DEPENDENCIES") or "true"
GIT_REF = environ.get("GITHUB_REF")
@@ -96,7 +96,7 @@ class RewriteArgs(Namespace):
for pyproject_file in pyproject_files:
print(
- f"Rewriting BL_Python dependency specifications in {pyproject_file} for filesystem build."
+ f"Rewriting Ligare dependency specifications in {pyproject_file} for filesystem build."
)
data: dict[str, Any]
@@ -107,26 +107,26 @@ class RewriteArgs(Namespace):
dependencies_hash = hash(tuple(dependencies))
for idx, dependency in enumerate(dependencies):
- if not dependency.startswith(BL_PYTHON):
+ if not dependency.startswith(LIGARE):
continue
- dependency_match = re.match(r"(BL_Python\.[^== 3.10`.
+**🚩** `Ligare` has a minimum Python version requirement of `>= 3.10`.
-* Create a BL_Python [web application](src/web/README.md)
-* Contribute to [BL_Python Development](https://github.com/uclahs-cds/BL_Python/wiki/BL_Python-Development). Run `make` to get started!
+* Create a Ligare [web application](src/web/README.md)
+* Contribute to [Ligare Development](https://github.com/uclahs-cds/Ligare/wiki/Ligare-Development). Run `make` to get started!
# Available Libraries
Following are each of the libraries in this repository.
-They can be used in Python under the `BL_Python` namespace. For example, to use the database libraries you would import from `BL_Python.database`.
+They can be used in Python under the `Ligare` namespace. For example, to use the database libraries you would import from `Ligare.database`.
-To use these packages during development of `BL_Python` itself, please refer to [Development](#development).
+To use these packages during development of `Ligare` itself, please refer to [Development](#development).
-## AWS [ `BL_Python.aws` ]
+## AWS [ `Ligare.aws` ]
Libraries for working with AWS.
-Review the `BL_Python.AWS` [readme](src/AWS/README.md)
+Review the `Ligare.AWS` [readme](src/AWS/README.md)
#### PyPI Package Name
-`bl-python.aws`
+`ligare.aws`
#### Git VCS URL
-`bl-python-aws@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/AWS`
+`ligare-aws@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/AWS`
-## Database [ `BL_Python.database` ]
+## Database [ `Ligare.database` ]
Libraries for working with SQLite and PostgreSQL databases.
-Review the `BL_Python.database` [readme](src/database/README.md)
+Review the `Ligare.database` [readme](src/database/README.md)
#### PyPI Package Name
-`bl-python.database`
+`ligare.database`
#### Git VCS URL
-`bl-python-database@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/database`
+`ligare-database@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/database`
-## Development [ `BL_Python.development` ]
+## Development [ `Ligare.development` ]
Utilities and tools for assisting in development of software.
-Review the `BL_Python.development` [readme](src/development/README.md)
+Review the `Ligare.development` [readme](src/development/README.md)
#### PyPI Package Name
-`bl-python.development`
+`ligare.development`
#### Git VCS URL
-`bl-python-development@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/development`
+`ligare-development@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/development`
-## Development [ `BL_Python.GitHub` ]
+## Development [ `Ligare.GitHub` ]
Utilities for working with the GitHub HTTP API. Uses `PyGithub` under the hood.
-Review the `BL_Python.GitHub` [readme](src/GitHub/README.md)
+Review the `Ligare.GitHub` [readme](src/GitHub/README.md)
#### PyPI Package Name
-`bl-python.github`
+`ligare.github`
#### Git VCS URL
-`bl-python-github@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/GitHub`
+`ligare-github@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/GitHub`
-## Platform [ `BL_Python.platform` ]
+## Platform [ `Ligare.platform` ]
Libraries for PaaS offerings such as tools for altering application configurations.
-Review the `BL_Python.platform` [readme](src/platform/README.md)
+Review the `Ligare.platform` [readme](src/platform/README.md)
#### PyPI Package Name
-`bl-python.platform`
+`ligare.platform`
#### Git VCS URL
-`bl-python-platform@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/platform`
+`ligare-platform@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/platform`
-## Programming [ `BL_Python.programming` ]
+## Programming [ `Ligare.programming` ]
Libraries used for writing software, such as pattern implementations so wheels don't need to be reinvented.
-Review the `BL_Python.programming` [readme](src/programming/README.md)
+Review the `Ligare.programming` [readme](src/programming/README.md)
#### PyPI Package Name
-`bl-python.programming`
+`ligare.programming`
#### Git VCS URL
-`bl-python-programming@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/programming`
+`ligare-programming@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/programming`
-## Testing [ `BL_Python.testing` ]
+## Testing [ `Ligare.testing` ]
Libraries used to aid in automated testing.
-Review the `BL_Python.testing` [readme](src/testing/README.md)
+Review the `Ligare.testing` [readme](src/testing/README.md)
#### PyPI Package Name
-`bl-python.testing`
+`ligare.testing`
#### Git VCS URL
-`bl-python-testing@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/testing`
+`ligare-testing@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/testing`
-## Web [ `BL_Python.web` ]
+## Web [ `Ligare.web` ]
Libraries used to building web applications.
-Review the `BL_Python.web` [readme](src/web/README.md)
+Review the `Ligare.web` [readme](src/web/README.md)
#### PyPI Package Name
-`bl-python.web`
+`ligare.web`
#### Git VCS URL
-`bl-python-web@ git+ssh://git@github.com/uclahs-cds/BL_Python.git@main#subdirectory=src/web`
+`ligare-web@ git+ssh://git@github.com/uclahs-cds/Ligare.git@main#subdirectory=src/web`
# Development
-Review [BL_Python Development](https://github.com/uclahs-cds/BL_Python/wiki/BL_Python-Development) for detailed information.
+Review [Ligare Development](https://github.com/uclahs-cds/Ligare/wiki/Ligare-Development) for detailed information.
diff --git a/docs/configuration.md b/docs/configuration.md
index 00333718..4cc85cde 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,6 +1,6 @@
# Application Configuration
-Detailed here are the supported options for configuring a `BL_Python.web` application in an application's `config.toml` file.
+Detailed here are the supported options for configuring a `Ligare.web` application in an application's `config.toml` file.
| Section | Option | Explanation | Allowed values |
| --- | --- | --- | --- |
@@ -13,7 +13,7 @@ Detailed here are the supported options for configuring a `BL_Python.web` applic
| | `host` | The server hostname used for binding and URL generation. This sets the hostname portion of the [SERVER_NAME](https://flask.palletsprojects.com/en/1.1.x/config/#SERVER_NAME) environment variable. | Review Flask's [SERVER_NAME](https://flask.palletsprojects.com/en/1.1.x/config/#SERVER_NAME) documentation for more information. |
| | `port` | The network port used for binding and URL generation. This sets the port portion of the [SERVER_NAME](https://flask.palletsprojects.com/en/1.1.x/config/#SERVER_NAME) environment variable. | Review Flask's [SERVER_NAME](https://flask.palletsprojects.com/en/1.1.x/config/#SERVER_NAME) documentation for more information. |
| **`flask.openapi`** | | | |
-| | `spec_path` | The filename path where the `openapi.yaml` file can be found. This path is relative to the `BL_Python.web` application directory. | Review Connexion's [add_api](https://connexion.readthedocs.io/en/2.14.2/autoapi/connexion/index.html#connexion.AbstractApp) documentation for more information. |
+| | `spec_path` | The filename path where the `openapi.yaml` file can be found. This path is relative to the `Ligare.web` application directory. | Review Connexion's [add_api](https://connexion.readthedocs.io/en/2.14.2/autoapi/connexion/index.html#connexion.AbstractApp) documentation for more information. |
| | `validate_responses` | During runtime, whether to validate the generated HTTP responses against the `openapi.yaml` specification. | Review Connexion's [add_api](https://connexion.readthedocs.io/en/2.14.2/autoapi/connexion/apps/flask_app/index.html#connexion.apps.flask_app.FlaskApp.add_api) documentation for more information. |
| | `use_swagger` | Whether to set up the Swagger UI. To use this option, you must install `connexion[swagger-ui]` with `pip`. | `true`, `false`, or can be unset. Review Connexion's [Swagger UI Console](https://connexion.readthedocs.io/en/2.14.2/quickstart.html#the-swagger-ui-console) documentation for more information. |
| | `swagger_url` | The absolute path at which the Swagger UI can be accessed via the browser. By default, this is `/`. | Review Connexion's [Swagger UI Path](https://connexion.readthedocs.io/en/2.14.2/routing.html#swagger-ui-path) documentation for more information. |
diff --git a/docs/processes/create_new_release.puml b/docs/processes/create_new_release.puml
index ca9682f8..92793f86 100644
--- a/docs/processes/create_new_release.puml
+++ b/docs/processes/create_new_release.puml
@@ -28,7 +28,7 @@
:Determine package version;
note right
Current version is in
- `src//BL_Python//~__init__.py`.
+ `src//Ligare//~__init__.py`.
end note
:Update the version number accordingly;
:Update the package CHANGELOG;
@@ -43,7 +43,7 @@
:Create new Git tags;
|Root package|
- :Name is `BL_Python.all-v1.0.0`;
+ :Name is `Ligare.all-v1.0.0`;
note
Replace `v1.0.0` with actual version.
end note
@@ -52,7 +52,7 @@
while (Any other package releases?) is (yes)
' this may be automated in the future
'if (Determine tag name from package and version) is (Root package) then
- :Name is `BL_Python.web-v1.0.0`;
+ :Name is `Ligare.web-v1.0.0`;
note
Replace `web` with actual package name
and `v1.0.0` with actual version.
diff --git a/docs/processes/create_new_release.svg b/docs/processes/create_new_release.svg
index 1d3d0c60..156aa515 100644
--- a/docs/processes/create_new_release.svg
+++ b/docs/processes/create_new_release.svg
@@ -1,4 +1,4 @@
-