ingot-sql 0.1.0__tar.gz → 0.7.0__tar.gz

ingot_sql-0.7.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: ingot-sql
+Version: 0.7.0
+Summary: Typed tables and typical queries for SQL databases in Ingots, raw SQL at hand.
+Keywords: ingots,sql,database
+Author: Aliaksandr Karotki
+Author-email: Aliaksandr Karotki <abkarotki@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Dist: ingots>=0.30.1,<0.31
+Requires-Python: >=3.14
+Project-URL: repository, https://github.com/ak-ingots/ingot-sql
+Project-URL: changelog, https://github.com/ak-ingots/ingot-sql/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# ingot-sql
+
+[![ci](https://github.com/ak-ingots/ingot-sql/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ak-ingots/ingot-sql/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ak-ingots/ingot-sql/blob/main/LICENSE)
+
+<!-- Links must be absolute: this README also renders on PyPI. -->
+
+Typed tables and typical queries for SQL databases in Ingots applications, with
+raw SQL and the driver at hand: what the addons of the SQL databases build on.
+An addon of [Ingots](https://github.com/ak-ingots/ingots).
+
+```python
+import ingot_sql
+
+
+class AppProject(ingot_sql.SqlProject):
+    env_configs_prefix = "APP"
+```
+
+An application with other addons joins the configs, the settings and the
+logging instead: `class AppConfigs(HttpConfigs, SqlConfigs)` with `SqlConfigs`
+from `ingot_sql.settings.configs`, and so on, as the addon guide of Ingots
+shows. The configs of the addon are named `SQL_*`: `SQL_LOGGING_LEVEL` sets the
+level of its logger, `ingot_sql`.
+
+**Status:** pre-alpha. The skeleton of the addon: its project, configs,
+settings and logging. Next, tables that are their records too, typical queries
+compiled to SQL you can read, raw SQL, and the base of the database addons.
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and `make`; uv fetches the
+interpreters it needs.
+
+```sh
+make                 # the target list
+make check           # everything CI runs: lint, test, coverage, wheel-test, cl-check
+make format          # black
+make all             # build the sdist and the wheel into dist/
+```
+
+- Every change users should know about adds a news fragment to `changelog.d/`
+  (see [its README](https://github.com/ak-ingots/ingot-sql/blob/main/changelog.d/README.md)).
+- A release is a pull request setting the version (`uv version X.Y.Z`) and
+  collating the changelog (`make cl-build VERSION=X.Y.Z`), then the tag
+  `vX.Y.Z` on `main`: the `release` workflow publishes the tested build to
+  TestPyPI, then to PyPI. Run by hand, it rehearses on TestPyPI only.
+
+## License
+
+[Apache 2.0](https://github.com/ak-ingots/ingot-sql/blob/main/LICENSE).

ingot_sql-0.7.0/README.md

@@ -0,0 +1,51 @@
+# ingot-sql
+
+[![ci](https://github.com/ak-ingots/ingot-sql/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ak-ingots/ingot-sql/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ak-ingots/ingot-sql/blob/main/LICENSE)
+
+<!-- Links must be absolute: this README also renders on PyPI. -->
+
+Typed tables and typical queries for SQL databases in Ingots applications, with
+raw SQL and the driver at hand: what the addons of the SQL databases build on.
+An addon of [Ingots](https://github.com/ak-ingots/ingots).
+
+```python
+import ingot_sql
+
+
+class AppProject(ingot_sql.SqlProject):
+    env_configs_prefix = "APP"
+```
+
+An application with other addons joins the configs, the settings and the
+logging instead: `class AppConfigs(HttpConfigs, SqlConfigs)` with `SqlConfigs`
+from `ingot_sql.settings.configs`, and so on, as the addon guide of Ingots
+shows. The configs of the addon are named `SQL_*`: `SQL_LOGGING_LEVEL` sets the
+level of its logger, `ingot_sql`.
+
+**Status:** pre-alpha. The skeleton of the addon: its project, configs,
+settings and logging. Next, tables that are their records too, typical queries
+compiled to SQL you can read, raw SQL, and the base of the database addons.
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and `make`; uv fetches the
+interpreters it needs.
+
+```sh
+make                 # the target list
+make check           # everything CI runs: lint, test, coverage, wheel-test, cl-check
+make format          # black
+make all             # build the sdist and the wheel into dist/
+```
+
+- Every change users should know about adds a news fragment to `changelog.d/`
+  (see [its README](https://github.com/ak-ingots/ingot-sql/blob/main/changelog.d/README.md)).
+- A release is a pull request setting the version (`uv version X.Y.Z`) and
+  collating the changelog (`make cl-build VERSION=X.Y.Z`), then the tag
+  `vX.Y.Z` on `main`: the `release` workflow publishes the tested build to
+  TestPyPI, then to PyPI. Run by hand, it rehearses on TestPyPI only.
+
+## License
+
+[Apache 2.0](https://github.com/ak-ingots/ingot-sql/blob/main/LICENSE).

ingot_sql-0.7.0/ingot_sql/__init__.py

@@ -0,0 +1,11 @@
+"""
+ingot-sql: Typed tables and typical queries for SQL databases in Ingots
+applications, with raw SQL and the driver at hand: what the addons of the
+SQL databases build on. An application inherits from :class:`SqlProject`, or
+joins the units of the addon, ``settings`` and ``logging``, with those of
+its other addons.
+"""
+
+__all__ = ("SqlProject",)
+
+from .project import SqlProject

ingot_sql-0.7.0/ingot_sql/__main__.py

@@ -0,0 +1,17 @@
+"""Runs the addon on its own: ``python -m ingot_sql logging info``."""
+
+import sys
+
+from ingots.defaults.logging import configure_startup_logging
+from ingots.puer.cli import CommandRunner
+
+from .project import SqlProject
+
+
+def main() -> None:
+    configure_startup_logging()
+    sys.exit(CommandRunner(SqlProject).run())
+
+
+if __name__ == "__main__":
+    main()

ingot_sql-0.7.0/ingot_sql/logging/__init__.py

@@ -0,0 +1,25 @@
+"""The logging unit of the defaults with the logger of the addon."""
+
+__all__ = ("SqlLogging",)
+
+import typing as t
+
+from ingots.defaults.logging import Logging
+
+if t.TYPE_CHECKING:
+    from ..project import SqlProject
+
+
+class SqlLogging(Logging):
+    """
+    The logging unit, with the logger of the addon, ``ingot_sql``, at
+    ``SQL_LOGGING_LEVEL``.
+    """
+
+    project: "SqlProject"
+
+    @t.override
+    def build_loggers(self) -> dict[str, dict[str, t.Any]]:
+        level = self.project.settings.configs.SQL_LOGGING_LEVEL
+        addon = {"level": level, "handlers": ["default"], "propagate": False}
+        return {**super().build_loggers(), "ingot_sql": addon}

ingot_sql-0.7.0/ingot_sql/project.py

@@ -0,0 +1,21 @@
+"""The project of the addon: what an application inherits from."""
+
+__all__ = ("SqlProject",)
+
+from ingots.defaults import Project
+from ingots.puer import Slot
+
+from .logging import SqlLogging
+from .settings import SqlSettings
+
+
+class SqlProject(Project):
+    """
+    The project of the defaults with the addon's :class:`SqlSettings` and
+    :class:`SqlLogging`. An application inherits from it and sets its own
+    ``env_configs_prefix``; the addon run on its own (``python -m ingot_sql``)
+    keeps the prefix of the defaults, ``INGOT``.
+    """
+
+    settings = Slot(SqlSettings)
+    logging = Slot(SqlLogging)

ingot_sql-0.7.0/ingot_sql/settings/__init__.py

@@ -0,0 +1,14 @@
+"""The settings unit of the defaults with the configs of the addon."""
+
+__all__ = ("SqlSettings",)
+
+from ingots.defaults.settings import Settings
+from ingots.puer import Slot
+
+from .configs import SqlConfigs
+
+
+class SqlSettings(Settings):
+    """The settings unit, with the addon's :class:`SqlConfigs`."""
+
+    configs = Slot(SqlConfigs)

ingot_sql-0.7.0/ingot_sql/settings/configs.py

@@ -0,0 +1,13 @@
+"""The configs of the addon, named ``SQL_*``."""
+
+__all__ = ("SqlConfigs",)
+
+import logging
+
+from ingots.defaults.settings.configs import Configs, LogLevelConfig
+
+
+class SqlConfigs(Configs):
+    """The configs of the defaults with those of SQL databases."""
+
+    SQL_LOGGING_LEVEL = LogLevelConfig(logging.INFO)

ingot_sql-0.7.0/pyproject.toml

@@ -0,0 +1,167 @@
+[project]
+name = "ingot-sql"
+version = "0.7.0"
+description = "Typed tables and typical queries for SQL databases in Ingots, raw SQL at hand."
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = [
+    "ingots",
+    "sql",
+    "database",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
+]
+dependencies = ["ingots>=0.30.1,<0.31"]
+
+[[project.authors]]
+name = "Aliaksandr Karotki"
+email = "abkarotki@gmail.com"
+
+[project.urls]
+repository = "https://github.com/ak-ingots/ingot-sql"
+changelog = "https://github.com/ak-ingots/ingot-sql/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv]
+required-version = ">=0.13.5"
+environments = [
+    "sys_platform == 'linux'",
+    "sys_platform == 'darwin'",
+]
+
+[tool.uv.build-backend]
+module-name = "ingot_sql"
+module-root = ""
+
+[tool.black]
+line-length = 88
+
+[tool.flake8]
+exclude = [
+    ".git",
+    ".venv",
+]
+max-line-length = 88
+extend-ignore = [
+    "E203",
+    "E701",
+    "E704",
+]
+class_attributes_order = [
+    "nested_class",
+    "constant",
+    "field",
+    "static_method",
+    "protected_static_method",
+    "class_method",
+    "protected_class_method",
+    "__init__",
+    "property_method",
+    "protected_property_method",
+    "magic_method",
+    "method",
+    "protected_method",
+]
+
+[tool.mypy]
+strict = true
+python_version = "3.14"
+enable_error_code = [
+    "deprecated",
+    "explicit-override",
+]
+
+[tool.towncrier]
+name = "ingot-sql"
+directory = "changelog.d"
+filename = "CHANGELOG.md"
+start_string = """
+<!-- towncrier release notes start -->
+"""
+title_format = "## [{version}] - {project_date}"
+issue_format = "[#{issue}](https://github.com/ak-ingots/ingot-sql/issues/{issue})"
+underlines = [
+    "",
+    "",
+    "",
+]
+wrap = false
+template = "changelog.d/_template.md"
+ignore = [
+    "README.md",
+    "_template.md",
+]
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "security"
+name = "Security"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Misc"
+showcontent = false
+
+[tool.coverage.run]
+branch = true
+source = ["ingot_sql"]
+
+[tool.coverage.report]
+fail_under = 99
+show_missing = true
+skip_covered = true
+exclude_also = [
+    "if t.TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]
+
+[dependency-groups]
+dev = [
+    "black",
+    "coverage",
+    "flake8",
+    "flake8-class-attributes-order",
+    "flake8-pyproject",
+    "mypy",
+]
+changelog = ["towncrier"]

ingot_sql-0.7.0/pyproject.toml.orig

@@ -0,0 +1,144 @@
+[project]
+name = "ingot-sql"
+version = "0.7.0"
+description = "Typed tables and typical queries for SQL databases in Ingots, raw SQL at hand."
+readme = "README.md"
+requires-python = ">=3.14"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{name = "Aliaksandr Karotki", email = "abkarotki@gmail.com"}]
+keywords = ["ingots", "sql", "database"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Typing :: Typed",
+]
+# Before 1.0 a minor version of ingots may break its addons.
+dependencies = ["ingots>=0.30.1,<0.31"]
+
+[project.urls]
+repository = "https://github.com/ak-ingots/ingot-sql"
+changelog = "https://github.com/ak-ingots/ingot-sql/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "ingot_sql"
+module-root = ""
+
+[tool.uv]
+# uv 0.13.5 drops the eMudhra roots from its certificates and its Pythons.
+required-version = ">=0.13.5"
+environments = ["sys_platform == 'linux'", "sys_platform == 'darwin'"]
+
+[dependency-groups]
+dev = [
+    "black",
+    "coverage",
+    "flake8",
+    "flake8-class-attributes-order",
+    "flake8-pyproject",
+    "mypy",
+]
+changelog = ["towncrier"]
+
+[tool.black]
+line-length = 88
+
+[tool.flake8]
+exclude = [".git", ".venv"]
+max-line-length = 88
+extend-ignore = ["E203", "E701", "E704"]
+# Member order of ADR 0007 (ingots-libs). `__init_subclass__` is written with an
+# explicit @classmethod, so it is checked as a class method.
+class_attributes_order = [
+    "nested_class",
+    "constant",
+    "field",
+    "static_method",
+    "protected_static_method",
+    "class_method",
+    "protected_class_method",
+    "__init__",
+    "property_method",
+    "protected_property_method",
+    "magic_method",
+    "method",
+    "protected_method",
+]
+
+[tool.mypy]
+strict = true
+python_version = "3.14"
+enable_error_code = ["deprecated", "explicit-override"]
+
+[tool.towncrier]
+name = "ingot-sql"
+directory = "changelog.d"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+title_format = "## [{version}] - {project_date}"
+issue_format = "[#{issue}](https://github.com/ak-ingots/ingot-sql/issues/{issue})"
+underlines = ["", "", ""]
+wrap = false
+template = "changelog.d/_template.md"
+ignore = ["README.md", "_template.md"]
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "security"
+name = "Security"
+showcontent = true
+
+# Internal changes users need not know about (agent rules, CI, test
+# refactoring): the fragment satisfies `cl-check`, its text is not published.
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Misc"
+showcontent = false
+
+[tool.coverage.run]
+branch = true
+source = ["ingot_sql"]
+
+[tool.coverage.report]
+fail_under = 99
+show_missing = true
+skip_covered = true
+exclude_also = [
+    "if t.TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]

ingot-sql-0.1.0/CHANGELOG.md

@@ -1,12 +0,0 @@
-# Changelog
-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/),
-
-## [Unreleased]
-
-## [0.1.0]
-### Added
-- Generate Ingots package structure.
-- Configure the `pre-commint` tool. See the `.pre-commit-config.yaml` config file for details.
-- Configure the `tox` tool. See the `tox.ini` config file for details.

ingot-sql-0.1.0/MANIFEST.in

@@ -1,7 +0,0 @@
-include CHANGELOG.md
-include LICENSE.md
-include README.md
-include requirements.txt
-graft ingot_sql/bootstrap/scaffolding
-global-exclude __pycache__
-global-exclude *.py[co]

ingot-sql-0.1.0/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.1
-Name: ingot-sql
-Version: 0.1.0
-Summary: Provides SQS functionality for Ingots projects.
-Home-page: https://github.com/ABKorotky/ingot-sql.git
-Author: Alexander Korotkiy
-Author-email: abkorotky@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
-Classifier: Development Status :: 1 - Planning
-Classifier: Environment :: Web Environment
-Classifier: Framework :: AsyncIO
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License (GPL)
-Classifier: Natural Language :: English
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Internet
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# Ingot Ingot Sql package.
-
-Provides SQS functionality for Ingots projects.
-
-## For consumers
-
-For using the Ingot package just execute the following commands:
-* Add the package to the `requirements.txt` file of your project.
-* Install int using the `pip` tool.
-* TODO. Add here something extra information.
-
-### Package CLI
-
-The package provides CLI.
-It allows to start working with the package quickly.
-It contains the following commands:
-TODO. Add builders here after generating their by the `ingots package_bootstrap` tool.
-
-For using the CLI tool just call the following command:
-```bash
-ingot-sql-cli <command>
-```
-Getting package CLI help:
-```bash
-ingot-sql-cli --help
-ingot-sql-cli <command> --help
-```
-
-## For developers
-
-### Prepare the project for working
-
-Clone a repository:
-```bash
-mkdir ingots-libs
-cd ingots-libs
-git clone https://github.com/ABKorotky/ingot-sql.git
-cd ingot-sql
-```
-
-Prepare a virtual environment:
-```bash
-python3.9 -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
-```
-
-Prepare repository hooks
-```bash
-pip install pre_commit
-pre-commit install
-pre-commit autoupdate
-```
-
-Configure code-quality tools:
-```bash
-pip install black flake8 mypy coverage
-```
-
-Configure the Sphinx tool
-
-Please, use the following page for configuring the Sphinx documentation generator: [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
-```bash
-pip install sphinx
-sphinx-build -b html docs docs/build -v
-```
-
-### Using the tox tool
-
-The Ingot package allows automation via the `tox` tool.
-```bash
-pip install tox
-```
-
-Use configured tox tool for several activities.
-
-`tox -e reformat` - auto reformat code by the black tool, makes ordering import too.
-
-`tox -e cs` - checks code style by PEP8.
-
-`tox -e ann` - checks annotations of types by the mypy tool.
-
-`tox -e utc` - runs unittests with the coverage tool.
-
-`tox -e report` - builds coverage report for the project.
-
-`tox -e doc` - builds a package documentation.
-
-`tox -e build` - builds a package form current branch / tag / commit.
-
-`tox -e upload` - uploads package to the PyPI index. Set the `PYPI_REPOSITORY_ALIAS` virtual variable for specify PyPI destination.
-
-Calling tox without parameters will execute the following steps: **cs**, **ann**, **utc** and **report**.
-
-### Using package CLI locally
-Obviously, it's impossible to call the package CLI via package entry-point.
-
-Use the following command instead:
-```bash
-python -m ingot_sql.scripts.ingot_sql ...
-```
-
-

ingot-sql-0.1.0/README.md

@@ -1,101 +0,0 @@
-# Ingot Ingot Sql package.
-
-Provides SQS functionality for Ingots projects.
-
-## For consumers
-
-For using the Ingot package just execute the following commands:
-* Add the package to the `requirements.txt` file of your project.
-* Install int using the `pip` tool.
-* TODO. Add here something extra information.
-
-### Package CLI
-
-The package provides CLI.
-It allows to start working with the package quickly.
-It contains the following commands:
-TODO. Add builders here after generating their by the `ingots package_bootstrap` tool.
-
-For using the CLI tool just call the following command:
-```bash
-ingot-sql-cli <command>
-```
-Getting package CLI help:
-```bash
-ingot-sql-cli --help
-ingot-sql-cli <command> --help
-```
-
-## For developers
-
-### Prepare the project for working
-
-Clone a repository:
-```bash
-mkdir ingots-libs
-cd ingots-libs
-git clone https://github.com/ABKorotky/ingot-sql.git
-cd ingot-sql
-```
-
-Prepare a virtual environment:
-```bash
-python3.9 -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
-```
-
-Prepare repository hooks
-```bash
-pip install pre_commit
-pre-commit install
-pre-commit autoupdate
-```
-
-Configure code-quality tools:
-```bash
-pip install black flake8 mypy coverage
-```
-
-Configure the Sphinx tool
-
-Please, use the following page for configuring the Sphinx documentation generator: [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
-```bash
-pip install sphinx
-sphinx-build -b html docs docs/build -v
-```
-
-### Using the tox tool
-
-The Ingot package allows automation via the `tox` tool.
-```bash
-pip install tox
-```
-
-Use configured tox tool for several activities.
-
-`tox -e reformat` - auto reformat code by the black tool, makes ordering import too.
-
-`tox -e cs` - checks code style by PEP8.
-
-`tox -e ann` - checks annotations of types by the mypy tool.
-
-`tox -e utc` - runs unittests with the coverage tool.
-
-`tox -e report` - builds coverage report for the project.
-
-`tox -e doc` - builds a package documentation.
-
-`tox -e build` - builds a package form current branch / tag / commit.
-
-`tox -e upload` - uploads package to the PyPI index. Set the `PYPI_REPOSITORY_ALIAS` virtual variable for specify PyPI destination.
-
-Calling tox without parameters will execute the following steps: **cs**, **ann**, **utc** and **report**.
-
-### Using package CLI locally
-Obviously, it's impossible to call the package CLI via package entry-point.
-
-Use the following command instead:
-```bash
-python -m ingot_sql.scripts.ingot_sql ...
-```

ingot-sql-0.1.0/ingot_sql/__init__.py

@@ -1,16 +0,0 @@
-"""Ingot Sql.
-
-Provides SQS functionality for Ingots projects.
-
-"""
-
-__all__ = ("NAME", "VERSION", "AUTHOR", "AUTHOR_EMAIL")
-
-NAME = "ingot-sql"
-TITLE = "Ingot Sql"
-DESCRIPTION = "Provides SQS functionality for Ingots projects."
-
-VERSION = "0.1.0"
-
-AUTHOR = "Alexander Korotkiy"
-AUTHOR_EMAIL = "abkorotky@gmail.com"

ingot-sql-0.1.0/ingot_sql/bootstrap/__init__.py

@@ -1,4 +0,0 @@
-"""Ingot Sql bootstrap."""
-from ingot_sql.bootstrap.base import IngotSqlBaseBuilder
-
-__all__ = ("IngotSqlBaseBuilder",)

ingot-sql-0.1.0/ingot_sql/bootstrap/base.py

@@ -1,15 +0,0 @@
-from logging import getLogger
-
-from ingots.bootstrap.base import BaseBuilder
-
-import ingot_sql as package
-
-__all__ = ("IngotSqlBaseBuilder",)
-
-
-logger = getLogger(__name__)
-
-
-class IngotSqlBaseBuilder(BaseBuilder):
-
-    package = package

ingot-sql-0.1.0/ingot_sql/bootstrap/scaffolding/__init__.py

@@ -1 +0,0 @@
-"""Ingot Sql bootstrap scaffolding."""

ingot-sql-0.1.0/ingot_sql/scripts/__init__.py

@@ -1 +0,0 @@
-"""Ingot Sql entry-points."""

ingot-sql-0.1.0/ingot_sql/scripts/ingot_sql.py

@@ -1,38 +0,0 @@
-import typing as t
-from logging import getLogger
-from logging import INFO
-
-from ingots.scripts.base import BaseDispatcher
-from ingots.utils.logging import configure_startup_logging
-
-if t.TYPE_CHECKING:
-    from ingots.operations import BaseCliOperation  # noqa
-
-
-__all__ = (
-    "IngotSqlDispatcher",
-    "main",
-)
-
-
-configure_startup_logging(
-    default_level=INFO,
-    format="%(levelname)s: %(message)s",
-)
-logger = getLogger(__name__)
-
-
-class IngotSqlDispatcher(BaseDispatcher):
-
-    name = "ingot_sql"
-    description = "The Ingot Sql management CLI."
-    cli_entities_classes: t.List[t.Type["BaseCliOperation"]] = []
-
-
-def main():
-    dispatcher = IngotSqlDispatcher.build()
-    dispatcher.run()
-
-
-if __name__ == "__main__":
-    main()

ingot-sql-0.1.0/ingot_sql/tests/__init__.py

@@ -1 +0,0 @@
-"""Tests for the Ingot Sql Ingot package."""

ingot-sql-0.1.0/ingot_sql/tests/functionals/__init__.py

@@ -1 +0,0 @@
-"""Functional tests for the Ingot Sql Ingot package."""

ingot-sql-0.1.0/ingot_sql/tests/units/__init__.py

@@ -1 +0,0 @@
-"""Unit tests for the Ingot Sql Ingot package."""

ingot-sql-0.1.0/ingot_sql/tests/units/bootstrap/__init__.py

@@ -1 +0,0 @@
-"""Tests for scripts of the Ingot Sql Ingot package."""

ingot-sql-0.1.0/ingot_sql/tests/units/bootstrap/test_base.py

@@ -1,17 +0,0 @@
-import typing as t
-
-from ingots.tests.units.bootstrap import test_base
-
-from ingot_sql.bootstrap import IngotSqlBaseBuilder
-
-__all__ = ("IngotSqlBaseBuilderTestCase",)
-
-
-class IngotSqlBaseBuilderTestCase(test_base.BaseBuilderTestCase):
-    """Contains tests for the IngotSqlBuilder class."""
-
-    tst_cls: t.Type = IngotSqlBaseBuilder
-    tst_entity_name: str = "ingot_sql"
-    tst_entity_name_upper: str = "INGOT_SQL"
-    tst_entity_name_class_name: str = "IngotSql"
-    tst_entity_description = "Provides SQS functionality for Ingots projects."

ingot-sql-0.1.0/ingot_sql/tests/units/scripts/__init__.py

@@ -1 +0,0 @@
-"""Tests for scripts of the Ingot Sql Ingot package."""

ingot-sql-0.1.0/ingot_sql/tests/units/scripts/test_ingot_sql.py

@@ -1,14 +0,0 @@
-import typing as t
-
-from ingots.tests.units.scripts import test_base
-
-from ingot_sql.scripts.ingot_sql import IngotSqlDispatcher
-
-__all__ = ("IngotSqlDispatcherTestCase",)
-
-
-class IngotSqlDispatcherTestCase(test_base.BaseDispatcherTestCase):
-    """Contains tests for the IngotSqlDispatcher class and checks it."""
-
-    tst_cls: t.Type = IngotSqlDispatcher
-    tst_builder_name = "test"

ingot-sql-0.1.0/ingot_sql.egg-info/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.1
-Name: ingot-sql
-Version: 0.1.0
-Summary: Provides SQS functionality for Ingots projects.
-Home-page: https://github.com/ABKorotky/ingot-sql.git
-Author: Alexander Korotkiy
-Author-email: abkorotky@gmail.com
-License: UNKNOWN
-Platform: UNKNOWN
-Classifier: Development Status :: 1 - Planning
-Classifier: Environment :: Web Environment
-Classifier: Framework :: AsyncIO
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License (GPL)
-Classifier: Natural Language :: English
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Topic :: Internet
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# Ingot Ingot Sql package.
-
-Provides SQS functionality for Ingots projects.
-
-## For consumers
-
-For using the Ingot package just execute the following commands:
-* Add the package to the `requirements.txt` file of your project.
-* Install int using the `pip` tool.
-* TODO. Add here something extra information.
-
-### Package CLI
-
-The package provides CLI.
-It allows to start working with the package quickly.
-It contains the following commands:
-TODO. Add builders here after generating their by the `ingots package_bootstrap` tool.
-
-For using the CLI tool just call the following command:
-```bash
-ingot-sql-cli <command>
-```
-Getting package CLI help:
-```bash
-ingot-sql-cli --help
-ingot-sql-cli <command> --help
-```
-
-## For developers
-
-### Prepare the project for working
-
-Clone a repository:
-```bash
-mkdir ingots-libs
-cd ingots-libs
-git clone https://github.com/ABKorotky/ingot-sql.git
-cd ingot-sql
-```
-
-Prepare a virtual environment:
-```bash
-python3.9 -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
-```
-
-Prepare repository hooks
-```bash
-pip install pre_commit
-pre-commit install
-pre-commit autoupdate
-```
-
-Configure code-quality tools:
-```bash
-pip install black flake8 mypy coverage
-```
-
-Configure the Sphinx tool
-
-Please, use the following page for configuring the Sphinx documentation generator: [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
-```bash
-pip install sphinx
-sphinx-build -b html docs docs/build -v
-```
-
-### Using the tox tool
-
-The Ingot package allows automation via the `tox` tool.
-```bash
-pip install tox
-```
-
-Use configured tox tool for several activities.
-
-`tox -e reformat` - auto reformat code by the black tool, makes ordering import too.
-
-`tox -e cs` - checks code style by PEP8.
-
-`tox -e ann` - checks annotations of types by the mypy tool.
-
-`tox -e utc` - runs unittests with the coverage tool.
-
-`tox -e report` - builds coverage report for the project.
-
-`tox -e doc` - builds a package documentation.
-
-`tox -e build` - builds a package form current branch / tag / commit.
-
-`tox -e upload` - uploads package to the PyPI index. Set the `PYPI_REPOSITORY_ALIAS` virtual variable for specify PyPI destination.
-
-Calling tox without parameters will execute the following steps: **cs**, **ann**, **utc** and **report**.
-
-### Using package CLI locally
-Obviously, it's impossible to call the package CLI via package entry-point.
-
-Use the following command instead:
-```bash
-python -m ingot_sql.scripts.ingot_sql ...
-```
-
-

ingot-sql-0.1.0/ingot_sql.egg-info/SOURCES.txt

@@ -1,25 +0,0 @@
-CHANGELOG.md
-LICENSE
-MANIFEST.in
-README.md
-requirements.txt
-setup.py
-ingot_sql/__init__.py
-ingot_sql.egg-info/PKG-INFO
-ingot_sql.egg-info/SOURCES.txt
-ingot_sql.egg-info/dependency_links.txt
-ingot_sql.egg-info/entry_points.txt
-ingot_sql.egg-info/requires.txt
-ingot_sql.egg-info/top_level.txt
-ingot_sql/bootstrap/__init__.py
-ingot_sql/bootstrap/base.py
-ingot_sql/bootstrap/scaffolding/__init__.py
-ingot_sql/scripts/__init__.py
-ingot_sql/scripts/ingot_sql.py
-ingot_sql/tests/__init__.py
-ingot_sql/tests/functionals/__init__.py
-ingot_sql/tests/units/__init__.py
-ingot_sql/tests/units/bootstrap/__init__.py
-ingot_sql/tests/units/bootstrap/test_base.py
-ingot_sql/tests/units/scripts/__init__.py
-ingot_sql/tests/units/scripts/test_ingot_sql.py

ingot-sql-0.1.0/ingot_sql.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

ingot-sql-0.1.0/ingot_sql.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-ingot-sql-cli = ingot_sql.scripts.ingot_sql:main
-

ingot-sql-0.1.0/ingot_sql.egg-info/requires.txt

@@ -1 +0,0 @@
-ingots~=0.17.2

ingot-sql-0.1.0/ingot_sql.egg-info/top_level.txt

@@ -1 +0,0 @@
-ingot_sql

ingot-sql-0.1.0/requirements.txt

@@ -1 +0,0 @@
-ingots~=0.17.2

ingot-sql-0.1.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

ingot-sql-0.1.0/setup.py

@@ -1,63 +0,0 @@
-import typing as t
-from os import path
-
-from pkg_resources import parse_requirements
-from setuptools import find_packages
-from setuptools import setup
-
-import ingot_sql as package
-
-
-URL = "https://github.com/ABKorotky/ingot-sql.git"
-ROOT_DIR = path.abspath(path.dirname(__file__))
-readme_filename = "README.md"
-requirements_file = "requirements.txt"
-
-
-def get_readme() -> str:
-    """get_readme.
-
-    Extracts content from the README.mg file for long description.
-    """
-    with open(path.join(ROOT_DIR, readme_filename)) as _file:
-        return _file.read()
-
-
-def get_requirements() -> t.List[str]:
-    """get_requirements.
-
-    Extracts requirements from the requirements.txt file.
-    """
-    with open(path.join(ROOT_DIR, requirements_file)) as _file:
-        return list((str(req) for req in parse_requirements(_file)))
-
-
-setup(
-    name=package.NAME,
-    description=package.DESCRIPTION,
-    long_description=get_readme(),
-    long_description_content_type="text/markdown",
-    version=package.VERSION,
-    url=URL,
-    author=package.AUTHOR,
-    author_email=package.AUTHOR_EMAIL,
-    packages=find_packages(),
-    include_package_data=True,
-    install_requires=get_requirements(),
-    entry_points={
-        "console_scripts": ["ingot-sql-cli = ingot_sql.scripts.ingot_sql:main []"]
-    },
-    classifiers=[
-        "Development Status :: 1 - Planning",
-        "Environment :: Web Environment",
-        "Framework :: AsyncIO",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: GNU General Public License (GPL)",
-        "Natural Language :: English",
-        "Operating System :: POSIX",
-        "Operating System :: POSIX :: Linux",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3.9",
-        "Topic :: Internet",
-    ],
-)