sqlscope 1.0.0__tar.gz

sqlscope-1.0.0/.gitignore

@@ -0,0 +1,186 @@
+# CUSTOM
+test_q.sql
+test_s?.sql
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+<<<<<<< Updated upstream
+# VS Code
+.vscode/
+=======
+.vscode
+>>>>>>> Stashed changes

sqlscope-1.0.0/.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

sqlscope-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Davide Ponzini, Davide Miggiano]
+
+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.

sqlscope-1.0.0/Makefile

@@ -0,0 +1,53 @@
+########## Makefile start ##########
+# Type: PyPi
+# Author: Davide Ponzini
+
+NAME=sqlscope
+VENV=./venv
+REQUIREMENTS=requirements.txt
+
+ifeq ($(OS),Windows_NT)
+	VENV_BIN=$(VENV)/Scripts
+else
+	VENV_BIN=$(VENV)/bin
+endif
+
+.PHONY: install build uninstall documentation test upload download clean coverage
+
+$(VENV):
+	python -m venv --clear $(VENV)
+	touch -a $(REQUIREMENTS)
+	$(VENV_BIN)/python -m pip install --upgrade -r $(REQUIREMENTS)
+
+$(VENV)_upgrade: $(VENV)
+	$(VENV_BIN)/python -m pip install --upgrade -r $(REQUIREMENTS)
+
+
+install: uninstall build
+	$(VENV_BIN)/python -m pip install ./dist/*.whl
+
+build: $(VENV)
+	rm -rf dist/
+	$(VENV_BIN)/python -m build
+
+uninstall: $(VENV)
+	$(VENV_BIN)/python -m pip uninstall -y $(NAME)
+
+documentation:
+	make html SPHINXBUILD="../$(VENV_BIN)/sphinx-build" -C docs/
+
+test: install
+	$(VENV_BIN)/python -m pytest
+
+upload: test documentation
+	$(VENV_BIN)/python -m pip install --upgrade twine
+	$(VENV_BIN)/python -m twine upload --verbose dist/*
+
+download: uninstall
+	$(VENV_BIN)/python -m pip install $(NAME)
+
+clean:
+	find . -type d -name '__pycache__' -print0 | xargs -0 rm -r || true
+	rm -rf dist docs/_build .pytest_cache .coverage tests/htmlcov
+
+########## Makefile end ##########

sqlscope-1.0.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: sqlscope
+Version: 1.0.0
+Summary: This project extracts catalog and query metadata from a SQL query.
+Project-URL: Repository, https://github.com/DavidePonzini/sqlscope
+Project-URL: Documentation, https://sqlscope.readthedocs.io/en/latest/index.html
+Project-URL: Bug Tracker, https://github.com/DavidePonzini/sqlscope/issues
+Author-email: Davide Ponzini <davide.ponzini95@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: psycopg2
+Requires-Dist: python-dateutil
+Requires-Dist: pyyaml
+Requires-Dist: sqlglot
+Requires-Dist: sqlparse
+Requires-Dist: z3-solver
+Description-Content-Type: text/markdown
+
+# Introduction
+This project extracts catalog and query metadata from a SQL query.
+Each SELECT statement is parsed as a list of tokens as well as an AST.
+The former works even for incomplete or invalid SQL queries, while the latter
+requires a valid SQL syntax.
+Additionally, catalog metadata is extracted from the database schema.
+
+# Details
+For each SELECT statement, the package extracts:
+- the list of SELECT queries (in case of set operations, nested queries, or ctes)
+- the main SELECT query
+- the list of schemas/tables/columns available in the catalog
+- the list of tables referenced in each query
+- the resulting table from each query execution, including its columns and their types
+- each clause of each query
+
+The catalog extract schema/table/column metadata.
+For each column, the following information are extracted:
+- name
+- data type
+- nullability
+- foreign key
+
+Additionally, for each table, PRIMARY KEY/UNIQUE constraints are extracted. This is also computed for the result of each SELECT query. 
+
+
+# Credits
+Special thanks to Flavio Venturini for his valuable contributions to the development of this project.
+
+# Limitations
+- Fully identified schema names are not supported when specifying column names (e.g. `SELECT schema.table.column [...]`)

sqlscope-1.0.0/README.md

@@ -0,0 +1,31 @@
+# Introduction
+This project extracts catalog and query metadata from a SQL query.
+Each SELECT statement is parsed as a list of tokens as well as an AST.
+The former works even for incomplete or invalid SQL queries, while the latter
+requires a valid SQL syntax.
+Additionally, catalog metadata is extracted from the database schema.
+
+# Details
+For each SELECT statement, the package extracts:
+- the list of SELECT queries (in case of set operations, nested queries, or ctes)
+- the main SELECT query
+- the list of schemas/tables/columns available in the catalog
+- the list of tables referenced in each query
+- the resulting table from each query execution, including its columns and their types
+- each clause of each query
+
+The catalog extract schema/table/column metadata.
+For each column, the following information are extracted:
+- name
+- data type
+- nullability
+- foreign key
+
+Additionally, for each table, PRIMARY KEY/UNIQUE constraints are extracted. This is also computed for the result of each SELECT query. 
+
+
+# Credits
+Special thanks to Flavio Venturini for his valuable contributions to the development of this project.
+
+# Limitations
+- Fully identified schema names are not supported when specifying column names (e.g. `SELECT schema.table.column [...]`)