pygosqlx 1.16.0__tar.gz

pygosqlx-1.16.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pygosqlx-1.16.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+include pyproject.toml
+recursive-include pygosqlx *.py *.pyi py.typed
+recursive-include pygosqlx/lib *.so *.dylib *.dll *.h
+recursive-include tests *.py

pygosqlx-1.16.0/PKG-INFO

@@ -0,0 +1,374 @@
+Metadata-Version: 2.4
+Name: pygosqlx
+Version: 1.16.0
+Summary: Python bindings for GoSQLX - High-performance SQL parser
+Author: GoSQLX Contributors
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://github.com/ajitpratap0/GoSQLX/tree/main/python#readme
+Project-URL: Homepage, https://github.com/ajitpratap0/GoSQLX
+Project-URL: Repository, https://github.com/ajitpratap0/GoSQLX
+Project-URL: Issues, https://github.com/ajitpratap0/GoSQLX/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# PyGoSQLX
+
+Python bindings for [GoSQLX](https://github.com/ajitpratap0/GoSQLX) -- a high-performance SQL parser written in Go. Parses, validates, formats, and analyzes SQL statements at native speed via a shared library (ctypes FFI).
+
+Powered by Go's compiled performance, PyGoSQLX is 100x+ faster than pure Python SQL parsers while providing a simple, Pythonic API.
+
+## Installation
+
+```bash
+pip install pygosqlx
+```
+
+Prebuilt wheels bundle the native `libgosqlx` library, so no Go toolchain is
+needed. pygosqlx is versioned in lockstep with GoSQLX: each GoSQLX release
+(starting with 1.16.0) publishes the matching pygosqlx version, whose wheels
+bundle the library built from that release.
+
+Wheels are available for Python 3.10-3.14 on:
+
+| Platform | Architectures | Wheel tag |
+|---|---|---|
+| Linux (glibc) | x86_64, aarch64 | `manylinux_2_17` (manylinux2014; glibc 2.17+, built on manylinux_2_28) |
+| macOS 13+ | x86_64, arm64 | `macosx_13_0` |
+| Windows | AMD64 | `win_amd64` |
+
+There are no wheels for musl-based Linux (Alpine) or 32-bit platforms. On
+those, pip falls back to the source distribution, which installs the Python
+package without the native library; build it as described below and point
+`GOSQLX_LIB_PATH` at it.
+
+### Building from source
+
+Requires a Go toolchain matching the repository's `go.mod` (Go 1.26+) with cgo
+enabled (a C compiler on `PATH`).
+
+```bash
+git clone https://github.com/ajitpratap0/GoSQLX.git
+cd GoSQLX/pkg/cbinding
+./build.sh          # writes python/pygosqlx/lib/libgosqlx.{so,dylib}
+cd ../../python
+pip install .       # or: pip install -e ".[dev]" for development
+```
+
+`build.sh` compiles the Go code into a shared library (`libgosqlx.so` on
+Linux, `libgosqlx.dylib` on macOS, `libgosqlx.dll` on Windows via MSYS2/MinGW)
+and places it in `python/pygosqlx/lib/`, where `pip install .` bundles it. Use
+`OUTPUT_DIR=/path/to/output ./build.sh` to write it elsewhere.
+
+Building a wheel without the library fails on purpose, so `pip install` on a
+platform with no prebuilt wheel (for example musl or 32-bit Linux) stops with
+an error instead of installing a package that cannot load. To install without
+a bundled library and supply one at runtime instead, set
+`PYGOSQLX_ALLOW_MISSING_LIB=1` for the install and point `GOSQLX_LIB_PATH` at
+the library:
+
+```bash
+PYGOSQLX_ALLOW_MISSING_LIB=1 pip install pygosqlx
+export GOSQLX_LIB_PATH=/path/to/libgosqlx.so
+```
+
+## Quick Start
+
+```python
+import pygosqlx
+
+# Parse SQL - raises ParseError on invalid SQL
+result = pygosqlx.parse("SELECT id, name FROM users WHERE active = true")
+print(result.statement_count)  # 1
+print(result.statement_types)  # ['SELECT']
+
+# Validate SQL syntax
+is_valid = pygosqlx.validate("SELECT * FROM users")
+print(is_valid)  # True
+
+is_valid = pygosqlx.validate("SELEC * FORM users")
+print(is_valid)  # False
+
+# Validate with detailed error info
+detail = pygosqlx.validate_detailed("SELEC * FORM users")
+if not detail.valid:
+    print(detail.error)        # Error message
+    print(detail.error_line)   # Line number
+    print(detail.error_column) # Column number
+
+# Format SQL
+formatted = pygosqlx.format("select id,name from users where id=1")
+print(formatted)
+
+# Extract table names
+tables = pygosqlx.extract_tables(
+    "SELECT u.name, o.total FROM users u JOIN orders o ON u.id = o.user_id"
+)
+print(tables)  # ['users', 'orders']
+
+# Extract column names
+columns = pygosqlx.extract_columns("SELECT id, name, email FROM users")
+print(columns)  # ['id', 'name', 'email']
+
+# Extract function calls
+functions = pygosqlx.extract_functions(
+    "SELECT COUNT(*), AVG(price) FROM orders"
+)
+print(functions)  # ['COUNT', 'AVG']
+
+# Extract all metadata at once
+meta = pygosqlx.extract_metadata(
+    "SELECT u.name, COUNT(o.id) FROM users u JOIN orders o ON u.id = o.user_id GROUP BY u.name"
+)
+print(meta.tables)     # ['users', 'orders']
+print(meta.columns)    # ['name', 'id']
+print(meta.functions)  # ['COUNT']
+# Qualified names available too:
+for qn in meta.tables_qualified:
+    print(f"{qn.schema}.{qn.name}" if qn.schema else qn.name)
+```
+
+### Dialects
+
+Every parsing function takes an optional keyword-only `dialect=` argument.
+Without it (or with `dialect=None`) the default parser is used, exactly as in
+earlier releases.
+
+```python
+print(pygosqlx.dialects())
+# ['generic', 'postgresql', 'mysql', 'mariadb', 'sqlserver', 'oracle',
+#  'sqlite', 'snowflake', 'bigquery', 'redshift', 'clickhouse']
+
+sql = "SELECT TOP 5 [id] FROM [dbo].[users]"
+pygosqlx.validate(sql)                       # False - not generic SQL
+pygosqlx.validate(sql, dialect="sqlserver")  # True
+pygosqlx.extract_tables(sql, dialect="sqlserver")  # ['dbo.users']
+pygosqlx.format("SELECT `id` FROM `users`", dialect="mysql")
+
+# An unknown dialect raises UnsupportedDialectError (also a ValueError)
+pygosqlx.parse("SELECT 1", dialect="postgres")  # use "postgresql"
+```
+
+### Linting
+
+`lint()` runs the same rule set as the `gosqlx lint` CLI command (L001-L010:
+whitespace, indentation, line length, column alignment, keyword case, comma
+placement, aliasing). SQL that does not parse is still linted by the text and
+token rules.
+
+```python
+result = pygosqlx.lint("select id from users  ", max_line_length=100)
+for v in result.violations:
+    print(v.rule, v.severity, v.line, v.column, v.message)
+# L001 warning 1 21 Line has trailing whitespace
+# L007 warning 1 1 Keyword 'select' should be uppercase: 'SELECT'
+# ...
+print(result.is_clean, result.violation_count)
+```
+
+### Security scanning
+
+`security_scan()` looks for SQL injection patterns (tautologies, comment
+bypasses, stacked queries, UNION injection, time-based and out-of-band
+techniques, dangerous functions). The scan works on the raw text, so payloads
+that are not valid SQL are scanned too.
+
+```python
+scan = pygosqlx.security_scan("SELECT * FROM users WHERE id = 1 OR 1=1 --")
+print(scan.is_clean, scan.has_critical)  # False True
+for f in scan.findings:
+    print(f.severity, f.pattern, f.description)
+```
+
+### Transpiling
+
+```python
+pygosqlx.transpile(
+    "CREATE TABLE t (id INT AUTO_INCREMENT PRIMARY KEY)", "mysql", "postgresql"
+)
+# 'CREATE TABLE t (id SERIAL PRIMARY KEY)'
+```
+
+Dedicated rewrites exist for MySQL to PostgreSQL, PostgreSQL to MySQL and
+PostgreSQL to SQLite. Other pairs are parsed with the source dialect and
+re-rendered without rewrites.
+
+### Library compatibility
+
+The functions and the `dialect=` argument added in 1.16.0 need a shared
+library built from a matching GoSQLX checkout. With an older library, calls
+without `dialect=` keep working, while `dialect=`, `lint()`,
+`security_scan()`, `transpile()` and `dialects()` raise `GoSQLXError` asking
+you to rebuild the library.
+
+### Error Handling
+
+```python
+from pygosqlx import parse, validate, extract_tables
+from pygosqlx.exceptions import ParseError, FormatError, GoSQLXError
+
+# parse() raises ParseError on invalid SQL
+try:
+    result = parse("SELECT * FORM users")
+except ParseError as e:
+    print(f"Error: {e.message}")
+    print(f"At line {e.line}, column {e.column}")
+
+# validate() returns a boolean (never raises)
+if not validate("BAD SQL"):
+    print("Invalid SQL")
+
+# extract_*() functions raise ParseError on invalid SQL
+try:
+    tables = extract_tables("NOT VALID SQL")
+except ParseError as e:
+    print(f"Parse error: {e}")
+
+# All exceptions inherit from GoSQLXError
+try:
+    parse("???")
+except GoSQLXError as e:
+    print(f"Caught: {e}")
+```
+
+## API Reference
+
+| Function | Returns | Description |
+|---|---|---|
+| `parse(sql, *, dialect=None)` | `ParseResult` | Parse SQL; raises `ParseError` on failure |
+| `validate(sql, *, dialect=None)` | `bool` | Check if SQL is syntactically valid |
+| `validate_detailed(sql, *, dialect=None)` | `ValidationResult` | Validate with error line/column details |
+| `format(sql, *, dialect=None)` | `str` | Format/pretty-print a SQL statement |
+| `extract_tables(sql, *, dialect=None)` | `list[str]` | Extract all table names |
+| `extract_columns(sql, *, dialect=None)` | `list[str]` | Extract all column names |
+| `extract_functions(sql, *, dialect=None)` | `list[str]` | Extract all function calls |
+| `extract_metadata(sql, *, dialect=None)` | `Metadata` | Extract tables, columns, functions, and qualified names |
+| `lint(sql, *, dialect=None, max_line_length=None)` | `LintResult` | Lint with the `gosqlx lint` rule set (L001-L010); `max_line_length` defaults to 100 |
+| `security_scan(sql)` | `SecurityScanResult` | Scan for SQL injection patterns |
+| `transpile(sql, from_dialect, to_dialect)` | `str` | Convert SQL between dialects; raises `TranspileError` on failure |
+| `dialects()` | `list[str]` | Names accepted by every `dialect` argument |
+| `version()` | `str` | Get the GoSQLX library version |
+
+`dialect` must be one of the names returned by `dialects()`; an unknown name
+raises `UnsupportedDialectError`.
+
+### Data Types
+
+| Type | Fields |
+|---|---|
+| `ParseResult` | `statement_count: int`, `statement_types: list[str]` |
+| `ValidationResult` | `valid: bool`, `error: str?`, `error_line: int?`, `error_column: int?` |
+| `Metadata` | `tables`, `columns`, `functions`, `tables_qualified`, `columns_qualified` |
+| `QualifiedName` | `name: str`, `schema: str`, `table: str` |
+| `LintResult` | `violations: list[LintViolation]`; properties `violation_count`, `is_clean` |
+| `LintViolation` | `rule`, `rule_name`, `severity`, `message`, `line`, `column`, `suggestion`, `can_auto_fix` |
+| `SecurityScanResult` | `findings: list[SecurityFinding]`, `total_count`, `critical_count`, `high_count`, `medium_count`, `low_count`; properties `is_clean`, `has_critical`, `has_high` |
+| `SecurityFinding` | `severity`, `pattern`, `description`, `risk`, `line: int?`, `column: int?`, `sql`, `suggestion` |
+
+### Exceptions
+
+| Exception | Base | When |
+|---|---|---|
+| `GoSQLXError` | `Exception` | Base for all PyGoSQLX errors |
+| `ParseError` | `GoSQLXError` | SQL parsing fails |
+| `FormatError` | `GoSQLXError` | SQL formatting fails |
+| `ValidationError` | `GoSQLXError` | SQL validation fails |
+| `TranspileError` | `GoSQLXError` | `transpile()` cannot parse or rewrite the SQL |
+| `UnsupportedDialectError` | `GoSQLXError`, `ValueError` | A `dialect` argument is not a supported dialect (`code` is `E4002`) |
+
+All exceptions have `message`, `code`, `line`, and `column` attributes.
+
+## Platform Support
+
+| Platform | Library | Prebuilt wheel | From source |
+|---|---|---|---|
+| Linux x86_64, aarch64 (glibc) | `.so` | Yes (glibc 2.17+) | Yes |
+| macOS x86_64, arm64 | `.dylib` | Yes (macOS 13+) | Yes |
+| Windows AMD64 | `.dll` | Yes | Yes (MSYS2/MinGW) |
+| Other (musl, 32-bit, ...) | - | No | Where Go supports `-buildmode=c-shared` |
+
+## Performance
+
+PyGoSQLX calls into compiled Go code via ctypes, avoiding the overhead of pure Python parsing. Typical performance characteristics:
+
+- **1M+ operations/sec** for simple queries
+- **Sub-microsecond** validation for short SQL statements
+- **Zero-copy** tokenization in the Go layer
+- **Object pooling** for minimal GC pressure
+
+This makes PyGoSQLX suitable for high-throughput use cases such as SQL proxies, query analyzers, and CI/CD validation pipelines.
+
+## Development
+
+### Running tests
+
+```bash
+cd python
+pytest -v                    # All tests
+pytest tests/test_types.py   # Type/exception tests (no shared library needed)
+pytest tests/test_integration.py  # Integration tests (requires shared library)
+pytest --cov=pygosqlx        # With coverage
+```
+
+To run the suite against an installed wheel instead of the checkout (as the
+release CI does):
+
+```bash
+pip install pygosqlx pytest   # or a locally built wheel
+cd /tmp && PYGOSQLX_TEST_INSTALLED=1 python -m pytest --import-mode=importlib /path/to/GoSQLX/python/tests
+```
+
+### Releasing
+
+Wheels for every supported platform and an sdist are built and tested by
+`.github/workflows/pygosqlx-release.yml` on each pull request that touches
+`python/` or `pkg/`. Pushing the GoSQLX release tag `vX.Y.Z` publishes them to
+PyPI through Trusted Publishing, so bump `pyproject.toml` and `__version__`
+in the release PR. Python-only follow-ups use a `pygosqlx-vX.Y.Z.postN` tag.
+Either tag must match `pyproject.toml` and point at a commit on `main`; tag
+pushes are the only path to PyPI. A manual dispatch
+can publish a dry run to TestPyPI. See the workflow header for the one-time PyPI setup.
+
+### Project structure
+
+```
+python/
+  pygosqlx/
+    __init__.py       # Package entry point, public API
+    core.py           # ctypes bindings to the Go shared library
+    exceptions.py     # Custom exception hierarchy
+    py.typed          # PEP 561 type hint marker
+    lib/              # Shared library output directory (built artifacts)
+  tests/
+    test_types.py                  # Type and exception tests (no shared library needed)
+    test_package_version.py        # Version metadata consistency
+    test_integration.py            # Integration tests with shared library
+    test_dialect_and_analysis.py   # dialect=, lint, security_scan, transpile, dialects
+    test_installed_wheel.py        # Installed-wheel checks (PYGOSQLX_TEST_INSTALLED=1)
+  scripts/
+    install-go-linux.sh  # Pinned, checksum-verified Go install for manylinux CI
+  pyproject.toml      # Package metadata and build config
+  setup.py            # Shim that tags wheels per platform (no metadata)
+```
+
+## License
+
+Apache-2.0. See the [LICENSE](https://github.com/ajitpratap0/GoSQLX/blob/main/LICENSE) file.