Rename to goodmem-nlweb / goodmem_nlweb, release 0.3.0

[bashareid]

Renames this integration to the goodmem-<framework> naming used by goodmem-adk and goodmem-semantic-kernel, published inside the PAIR Systems (pairsysai) PyPI organisation. Version 0.3.0. The version is a minor bump because the import path change is breaking.

	Before (main, 0.2.2)	After (0.3.0)
Distribution	nlweb-goodmem	goodmem-nlweb
Import package	nlweb_goodmem	goodmem_nlweb
NLWeb import_path	nlweb_goodmem	goodmem_nlweb

What changes for users

• Install: pip install goodmem-nlweb.
• Breaking: from goodmem_nlweb import GoodMemRetrievalProvider, GoodMemObjectLookupProvider, upload_documents replaces the old import. There is no compatibility shim.
• Breaking, NLWeb config: NLWeb imports the provider from the YAML import_path, so provider entries become:

  retrieval:
    default:
      import_path: goodmem_nlweb
      class_name: GoodMemRetrievalProvider

  (the same applies to object_storage.default).
• Memory metadata keys stored on the GoodMem server (url, site, schema_json) are unchanged, so existing spaces read exactly as before.
• nlweb-goodmem stays at 0.2.2 on PyPI.

Before merging

This repo has release-on-merge.yml: merging this PR publishes immediately. When CI passes on main, it tags the merge v0.3.0 and dispatches publish.yml, which uploads via Trusted Publishing. The pending publisher for goodmem-nlweb must exist on PyPI first, or the publish job fails.

In the pairsysai organisation on PyPI, go to Publishing and choose "Add a new pending publisher". Enter these values, read from this repo:

Field	Value
PyPI project name	goodmem-nlweb
Owner	PAIR-Systems-Inc
Repository name	goodmem_nlweb
Workflow name	publish.yml
Environment name	pypi

release-on-merge.yml reads name and version from pyproject.toml, so its PyPI check queries https://pypi.org/pypi/goodmem-nlweb/0.3.0/json. That URL returns 404 today, so the release will publish. The tag v0.3.0 does not exist yet.

Changes

• src/nlweb_goodmem/ → src/goodmem_nlweb/ (git mv). All internal imports are updated.
• pyproject.toml: name = "goodmem-nlweb", version = "0.3.0", hatch wheel packages and sdist include paths, and [tool.mypy] packages. __version__ = "0.3.0".
• .github/workflows/ci.yml: the clean-env smoke test installs dist/goodmem_nlweb-*.whl and runs from goodmem_nlweb import ….
• .github/workflows/publish.yml: environment URL https://pypi.org/project/goodmem-nlweb/, plus the pending-publisher setup comment.
• README.md: title, install line, the YAML import_path (retrieval and object_storage) and the Python samples.
• Docstrings in __init__.py and provider.py carry the YAML import_path: goodmem_nlweb. tests/test_config.py loads those docstrings and the README YAML with nlweb-core's own load_config / initialize_providers, so the new import_path is exercised for real.
• Tests: imports, the caplog logger name (goodmem_nlweb.provider; the module uses logging.getLogger(__name__)), the throwaway e2e space label, and the regression-suite docstring.
• examples/nlweb_provider.py: import.
• CHANGELOG.md: one 0.3.0 entry (renamed; breaking: update imports and import_path). Older entries keep the old name as history.

Grep for nlweb[-_. ]?goodmem (case-insensitive) has 5 hits, all in CHANGELOG.md: the 0.3.0 entry names the old import in its "update from" instructions (2 lines), and 3 lines in older history entries are left as written.

What failed before, and how it behaves now

Before (main):

$ python -m build -w && ls dist
nlweb_goodmem-0.2.2-py3-none-any.whl
$ pip install dist/nlweb_goodmem-0.2.2-py3-none-any.whl && python -c "import goodmem_nlweb"
ModuleNotFoundError: No module named 'goodmem_nlweb'
$ pip install goodmem-nlweb
ERROR: No matching distribution found for goodmem-nlweb

After (this branch):

$ python -m build && ls dist
goodmem_nlweb-0.3.0-py3-none-any.whl  goodmem_nlweb-0.3.0.tar.gz
$ unzip -p dist/goodmem_nlweb-0.3.0-py3-none-any.whl goodmem_nlweb-0.3.0.dist-info/METADATA | grep -E '^(Name|Version):'
Name: goodmem-nlweb
Version: 0.3.0
$ unzip -l dist/goodmem_nlweb-0.3.0-py3-none-any.whl   # top-level entries: goodmem_nlweb/ (10 files), goodmem_nlweb-0.3.0.dist-info/ (4)
$ twine check dist/*            # PASSED x2
$ python -m venv .venv-smoke && .venv-smoke/bin/pip install dist/goodmem_nlweb-*.whl
$ .venv-smoke/bin/python -c "import goodmem_nlweb; print(goodmem_nlweb.__version__)"
0.3.0
$ .venv-smoke/bin/python -c "import nlweb_goodmem"
ModuleNotFoundError: No module named 'nlweb_goodmem'

pip install goodmem-nlweb works from PyPI once this is merged and published.

Local CI, run the way ci.yml runs it from a fresh venv: ruff check src tests examples is clean, mypy is clean (9 files), and pytest -m "not integration" gives 194 passed, 1 skipped. Also run: bash -n on every run: block of the three workflows, and the gm_ key scan over the tree and the diff (both clean).

🤖 Generated with Claude Code