chore: rename the published distribution to nl2sql-engine by nadeem4 · Pull Request #62 · nadeem4/nl2sql

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

nadeem4 · 2026-08-28T14:06:59Z

Why

The PyPI distribution name nl2sql is already taken by an unrelated, abandoned
project (v0.0.0, author "Madhup Sukoon"). A trusted publisher cannot be configured
for a name we do not own, so the first release is blocked until the distribution is
renamed. nl2sql-engine is available; nl2sql-api and nl2sql-adapter-sdk are ours
and are unchanged.

What actually changes

Only the PyPI distribution name. The Python import package stays nl2sql.

import nl2sql, from nl2sql.cli.main import ..., nl2sql.adapters.* — unchanged
packages/nl2sql/ and packages/nl2sql/src/nl2sql/ — unchanged
The nl2sql console script — unchanged
The nl2sql.adapters entry-point group — unchanged
No directory renamed, no import statement touched, no version number touched
(release-please owns versions and CHANGELOG.md)

Changed:

packages/nl2sql/pyproject.toml — name = "nl2sql" → nl2sql-engine
packages/api/pyproject.toml — dependency nl2sql~=0.1 → nl2sql-engine~=0.1
(constraint form kept)
release-please-config.json — "package-name" → nl2sql-engine
(.release-please-manifest.json is keyed by path ".", so it needs no change)
packages/nl2sql/src/nl2sql/cli/config.py — KNOWN_ADAPTERS values are passed
straight to pip install by nl2sql install / setup / doctor, so they must be
distribution names: nl2sql[postgres] → nl2sql-engine[postgres], and so on
nl2sql/secrets/{factory,providers/*}.py — "Install nl2sql[aws]"-style hints
Docs and READMEs — every pip install nl2sql... that installs from PyPI

Deliberately not changed: pip install -e "packages/nl2sql[postgres]" in
CI, CONTRIBUTING.md, docs/getting_started/{source,demo,docker}.md and
packages/api/Dockerfile. Those are path-based editable/local installs pointing
at a directory that has not moved.

The wheel-glob fix (the highest-risk item)

PyPI normalises - to _ in wheel filenames, so the built wheel becomes
nl2sql_engine-0.1.0-py3-none-any.whl. The existing smoke-install glob
dist/nl2sql-*.whl no longer matches it — it would have matched nothing and let the
release gate pass while publishing an untested wheel. Fixed in both places:

.github/workflows/publish_pypi.yaml:39
.github/workflows/test.yml:129

-dist/nl2sql_adapter_sdk-*.whl dist/nl2sql-*.whl dist/nl2sql_api-*.whl
+dist/nl2sql_adapter_sdk-*.whl dist/nl2sql_engine-*.whl dist/nl2sql_api-*.whl

Also: a missing human setup step

docs/development/releasing.md documented two one-time human setup steps. A third
one is required and had blocked the pipeline in practice: Settings → Actions →
General → Workflow permissions → "Allow GitHub Actions to create and approve pull
requests". Without it release_please.yml creates its branch and commit, then
fails with GitHub Actions is not permitted to create or approve pull requests.
The repo currently has can_approve_pull_request_reviews: false.

Verification

Unit suite: 231 passed, 1 skipped, 47 deselected — unchanged, run twice
Key-free integration suite: 28 passed — unchanged, run twice
All three wheels build; engine wheel is nl2sql_engine-0.1.0-py3-none-any.whl
Clean-venv smoke install using the updated CI globs: installs
nl2sql-adapter-sdk-0.1.0, nl2sql-engine-0.1.0, nl2sql-api-0.1.0;
import nl2sql works, nl2sql --help works, nl2sql list-adapters lists all
five adapters as Active; nl2sql doctor renders the new
nl2sql-engine[...] install hints correctly
pip show nl2sql-engine reports the new name; pip show nl2sql reports not found
mkdocs build --strict clean; docs prose-path sweep clean

chore: rename the published distribution to nl2sql-engine
6b8c44c

nadeem4 merged commit 6c5097d into mainAug 28, 2026
8 checks passed

nadeem4 deleted the chore/rename-distribution-to-nl2sql-engine branch August 28, 2026 14:09

nadeem4 mentioned this pull request Sep 1, 2026
docs: sync documentation with recent changes #77
Open