dbdocs 0.0.1__tar.gz

dbdocs-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dat Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dbdocs-0.0.1/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: dbdocs
+Version: 0.0.1
+Summary: Auto-generated data documentation site for dbt projects
+Home-page: https://github.com/datnguye/dbt-docs
+License: MIT
+Keywords: flake8,markdown,lint
+Author: Dat Nguyen
+Author-email: datnguyen.it09@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Dist: click (>=8.1,<9.0)
+Requires-Dist: dbterd (>=1,<2)
+Requires-Dist: jinja2 (>=3.1,<4.0)
+Project-URL: Repository, https://github.com/datnguye/dbt-docs
+Description-Content-Type: text/markdown
+
+# dbt-docs
+
+<!-- [![PyPI version](https://badge.fury.io/py/dbterd.svg)](https://pypi.org/project/dbterd/)
+![python-cli](https://img.shields.io/badge/CLI-Python-FFCE3E?labelColor=14354C&logo=python&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![python](https://img.shields.io/badge/Python-3.9|3.10|3.11-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+[![codecov](https://codecov.io/gh/datnguye/dbterd/branch/main/graph/badge.svg?token=N7DMQBLH4P)](https://codecov.io/gh/datnguye/dbterd) -->
+
+Alternative dbt docs 🚀
+
+```bash
+pip install dbdocs --upgrade
+```
+
+Verify installation:
+
+```bash
+dbdocs --version
+```
+

dbdocs-0.0.1/README.md

@@ -0,0 +1,19 @@
+# dbt-docs
+
+<!-- [![PyPI version](https://badge.fury.io/py/dbterd.svg)](https://pypi.org/project/dbterd/)
+![python-cli](https://img.shields.io/badge/CLI-Python-FFCE3E?labelColor=14354C&logo=python&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![python](https://img.shields.io/badge/Python-3.9|3.10|3.11-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+[![codecov](https://codecov.io/gh/datnguye/dbterd/branch/main/graph/badge.svg?token=N7DMQBLH4P)](https://codecov.io/gh/datnguye/dbterd) -->
+
+Alternative dbt docs 🚀
+
+```bash
+pip install dbdocs --upgrade
+```
+
+Verify installation:
+
+```bash
+dbdocs --version
+```

dbdocs-0.0.1/dbdocs/__main__.py

@@ -0,0 +1,3 @@
+from dbdocs import main
+
+main.main()

dbdocs-0.0.1/dbdocs/cli/main.py

@@ -0,0 +1,29 @@
+import importlib.metadata
+import click
+from dbdocs.helpers.log import logger
+
+__version__ = importlib.metadata.version("dbdocs")
+
+
+# dbdocs
+@click.group(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    invoke_without_command=True,
+    no_args_is_help=True,
+    epilog="Specify one of these sub-commands and you can find more help from there.",
+)
+@click.version_option(__version__)
+@click.pass_context
+def dbdocs(ctx, **kwargs):
+    """Auto-generated data documentation site for dbt projects"""
+    logger.info(f"Run with dbdocs=={__version__}")
+
+
+# dbtdocs run
+@dbdocs.command(name="generate")
+@click.pass_context
+def generate(ctx, **kwargs):
+    """
+    Generate static sites
+    """
+    pass

dbdocs-0.0.1/dbdocs/helpers/log.py

@@ -0,0 +1,37 @@
+import logging
+
+
+class LogFormatter(logging.Formatter):
+
+    grey = "\x1b[38;20m"
+    blue = "\x1b[34;20m"
+    yellow = "\x1b[33;20m"
+    red = "\x1b[31;20m"
+    bold_red = "\x1b[31;1m"
+    reset = "\x1b[0m"
+    format = (
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s (%(filename)s:%(lineno)d)"
+    )
+
+    FORMATS = {
+        logging.DEBUG: blue + format + reset,
+        logging.INFO: grey + format + reset,
+        logging.WARNING: yellow + format + reset,
+        logging.ERROR: red + format + reset,
+        logging.CRITICAL: bold_red + format + reset,
+    }
+
+    def format(self, record):
+        log_fmt = self.FORMATS.get(record.levelno)
+        formatter = logging.Formatter(log_fmt)
+        return formatter.format(record)
+
+
+logger = logging.getLogger("dbterd")
+logger.setLevel(logging.DEBUG)
+
+if len(logger.handlers) == 0:
+    ch = logging.StreamHandler()
+    ch.setLevel(logging.DEBUG)
+    ch.setFormatter(LogFormatter())
+    logger.addHandler(ch)

dbdocs-0.0.1/dbdocs/main.py

@@ -0,0 +1,6 @@
+from dbdocs.cli import main as cli
+
+
+def main():
+    """dbdocs entrypoint"""
+    cli.dbdocs()

dbdocs-0.0.1/pyproject.toml

@@ -0,0 +1,97 @@
+[tool.poetry]
+name = "dbdocs"
+version = "0.0.1"
+description = "Auto-generated data documentation site for dbt projects"
+authors = ["Dat Nguyen <datnguyen.it09@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/datnguye/dbt-docs"
+repository = "https://github.com/datnguye/dbt-docs"
+keywords = ["flake8", "markdown", "lint"]
+classifiers = [
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Quality Assurance",
+]
+include = [
+    "LICENSE",
+]
+packages = [
+  {include = "dbdocs"},
+  {include = "README.md"},
+]
+
+[tool.poetry.scripts]
+dbdocs = "dbdocs.main:main"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+click = "^8.1"
+dbterd = "^1"
+jinja2 = "^3.1"
+
+[tool.poetry.group.dev.dependencies]
+dbt-postgres = "^1.5"
+pytest = "^6.2.5"
+pytest-sugar = "^0.9.6"
+black = "^22.10.0"
+coverage = {version = "^6.5.0", extras = ["toml"]}
+poethepoet = "^0.16.4"
+pre-commit = "^2.20.0"
+flake8 = "^6.0.0"
+isort = "^5.12.0"
+autoflake = "^2.0.1"
+mkdocs = "^1.4.2"
+mkdocs-minify-plugin = "^0.6.4"
+mkdocs-material = "^9.1.5"
+mike = "^1.1.2"
+pdoc = "^14.4.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+multi_line_output = 3
+force_to_top = ["os"]
+profile = "black"
+skip_gitignore = true
+
+[tool.autoflake]
+recursive = true
+in-place = true
+remove-all-unused-imports = true
+ignore-init-module-imports = true
+remove-unused-variables = true
+ignore-pass-statements = false
+
+[tool.coverage.run]
+omit = ["tests/*"]
+
+[tool.poe.tasks]
+git-hooks = { shell = "pre-commit install --install-hooks && pre-commit install --hook-type commit-msg" }
+format = [
+  {cmd = "autoflake ."},
+  {cmd = "black ."},
+  {cmd = "isort ."},
+]
+lint = [
+  {cmd = "black --check ."},
+  {cmd = "isort --check-only ."},
+  {cmd = "flake8 ."},
+]
+test = [
+  {cmd = "pytest . -vv"},
+]
+test-cov = [
+  {cmd = "pytest --version"},
+  {cmd = "coverage run -m pytest ."},
+  {cmd = "coverage report --show-missing"},
+  {cmd = "coverage xml"},
+]
+build-doc-and-serve = [
+  {cmd = "mkdocs build"},
+  {cmd = "mkdocs serve"}
+]