bqsqlparse 0.1.0__tar.gz

bqsqlparse-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.venv/
+.coverage

bqsqlparse-0.1.0/DEPLOYMENT.md

@@ -0,0 +1,148 @@
+# Deploying `bqsqlparse` to PyPI
+
+A step-by-step guide to publish this package, from first release to automated
+CI publishing.
+
+## 0. Prerequisites
+
+```bash
+python3 -m pip install --upgrade build twine
+```
+
+- A [PyPI account](https://pypi.org/account/register/) (and optionally a
+  [TestPyPI account](https://test.pypi.org/account/register/) — they are
+  separate registrations)
+- Two-factor authentication enabled on PyPI (required for uploads)
+
+## 1. Pre-flight checklist
+
+1. **Name availability** — confirm `bqsqlparse` is free:
+   https://pypi.org/project/bqsqlparse/ (404 = available). If taken, change
+   `name` in [pyproject.toml](pyproject.toml).
+2. **Version** — bump the version in *both* places:
+   - `version` in [pyproject.toml](pyproject.toml)
+   - `__version__` in [src/bqsqlparse/__init__.py](src/bqsqlparse/__init__.py)
+
+   Follow [SemVer](https://semver.org/): `0.1.0` → `0.1.1` (fix),
+   `0.2.0` (feature), `1.0.0` (stable API). PyPI never allows re-uploading
+   the same version.
+3. **Metadata** — update `authors`, and the `[project.urls]` section to point
+   at your real repository.
+4. **Tests pass**:
+
+   ```bash
+   pip install -e ".[dev]"
+   pytest
+   ```
+
+## 2. Build the distributions
+
+From the package root:
+
+```bash
+rm -rf dist/
+python3 -m build
+```
+
+This creates:
+
+```
+dist/bqsqlparse-0.1.0.tar.gz          # source distribution (sdist)
+dist/bqsqlparse-0.1.0-py3-none-any.whl # wheel
+```
+
+Validate the metadata renders correctly on PyPI:
+
+```bash
+python3 -m twine check dist/*
+```
+
+Both files should report `PASSED`.
+
+## 3. (Recommended) Dry-run on TestPyPI
+
+```bash
+python3 -m twine upload --repository testpypi dist/*
+```
+
+When prompted, use `__token__` as the username and a TestPyPI API token
+(create one at https://test.pypi.org/manage/account/token/) as the password.
+
+Verify installation from TestPyPI in a clean environment:
+
+```bash
+python3 -m venv /tmp/bqtest && source /tmp/bqtest/bin/activate
+pip install --index-url https://test.pypi.org/simple/ bqsqlparse
+python3 -c "import bqsqlparse; print(bqsqlparse.parse_one('SELECT 1').sql())"
+deactivate
+```
+
+## 4. Publish to PyPI
+
+Create an API token at https://pypi.org/manage/account/token/
+(scope it to just this project after the first upload), then:
+
+```bash
+python3 -m twine upload dist/*
+# username: __token__
+# password: pypi-AgEIcHlwaS5vcmc...   (your token)
+```
+
+To avoid typing the token every time, create `~/.pypirc`:
+
+```ini
+[pypi]
+username = __token__
+password = pypi-AgEIcHlwaS5vcmc...
+```
+
+(`chmod 600 ~/.pypirc` — never commit this file.)
+
+Your package is now live: `pip install bqsqlparse` 🎉
+
+## 5. Tag the release
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## 6. (Best practice) Automate with GitHub Actions + Trusted Publishing
+
+Trusted Publishing removes the need for long-lived API tokens entirely.
+
+1. On PyPI: *Your project → Manage → Publishing → Add a new publisher*.
+   Enter your GitHub `owner/repo`, workflow file name `publish.yml`, and
+   environment name `pypi`.
+2. This repo already ships the workflow at
+   [.github/workflows/publish.yml](.github/workflows/publish.yml). It:
+   - runs the test suite on every push/PR
+   - builds and publishes to PyPI whenever you push a `v*` tag
+3. Release flow becomes just:
+
+   ```bash
+   # bump version in pyproject.toml + __init__.py, commit, then:
+   git tag v0.2.0 && git push origin v0.2.0
+   ```
+
+## 7. Releasing new versions — quick reference
+
+```bash
+# 1. bump version (pyproject.toml + src/bqsqlparse/__init__.py)
+# 2. update CHANGELOG / README if needed
+pytest                      # 3. green tests
+rm -rf dist && python3 -m build   # 4. build
+python3 -m twine check dist/*     # 5. validate
+python3 -m twine upload dist/*    # 6. upload (or push a v* tag for CI)
+git tag vX.Y.Z && git push origin vX.Y.Z
+```
+
+## Troubleshooting
+
+| Error | Fix |
+| --- | --- |
+| `File already exists` | Version already uploaded — bump the version and rebuild |
+| `Invalid or non-existent authentication` | Username must be literally `__token__`; token must include the `pypi-` prefix |
+| `The name 'bqsqlparse' is too similar to an existing project` | Pick a different `name` in pyproject.toml |
+| README renders badly on PyPI | Run `twine check dist/*`; ensure `readme = "README.md"` and valid Markdown |
+| Wrong files in the wheel | Inspect with `unzip -l dist/*.whl`; adjust `[tool.hatch.build.targets.wheel]` |

bqsqlparse-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vamsi Kapa
+
+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.