Skip to content

chore: rename PyPI distribution to socialapis-sdk#3

Merged
OussemaFr merged 1 commit into
mainfrom
chore/rename-pypi-to-socialapis-sdk
Jun 22, 2026
Merged

chore: rename PyPI distribution to socialapis-sdk#3
OussemaFr merged 1 commit into
mainfrom
chore/rename-pypi-to-socialapis-sdk

Conversation

@OussemaFr

Copy link
Copy Markdown
Member

Why

The bare `socialapis` name on PyPI is already taken/squatted — PyPI's name-similarity check refused the registration. `socialapis-sdk` is distinct enough to pass and follows the standard Python SDK naming convention.

What changes

  • `pyproject.toml`: `name = "socialapis"` → `"socialapis-sdk"`
  • `.github/workflows/release.yml`: tag-vs-version check now expects `socialapis_sdk-*.tar.gz` (PEP 625 normalises hyphens to underscores in built distribution filenames). Environment URL also updated.
  • `README.md`: install commands + PyPI version badges point at the new name
  • `CHANGELOG.md`: callout for the rename

What does NOT change

  • The Python import path — users still write `from socialapis import Facebook`. The PyPI distribution name and the Python import name are independent.
  • The package directory on disk (`socialapis/`)
  • Any code, any test, any docstring inside the package
  • The Pending Trusted Publisher on PyPI (already configured for `socialapis-sdk` → this repo's `release.yml`)

So for downstream users, the only thing different is the install line: `pip install socialapis-sdk` instead of `pip install socialapis`. Code inside their app is identical.

Test plan

Local sanity check before push:

```
ruff check . → All checks passed!
pytest → 33 passed, coverage 77.56% (gate: 70%)
```

After merge, the path to first release:

  1. Pull main locally
  2. `git tag v0.1.0 && git push origin v0.1.0`
  3. Watch the release workflow at github.com/SocialAPIsHub/socialapis-python/actions
  4. Verify with `pip install socialapis-sdk` once the workflow goes green

The bare `socialapis` name on PyPI was already taken / squatted —
PyPI's name-similarity check refused the registration. `socialapis-sdk`
is distinct enough to pass and follows the common Python SDK naming
convention (`<brand>-sdk`).

What changed:
- pyproject.toml: name = "socialapis" → "socialapis-sdk"
- release.yml: tag-vs-version check now expects socialapis_sdk-*.tar.gz
  (PEP 625 normalises hyphens to underscores in built distributions)
- release.yml: environment.url points to the new project page
- README.md: install commands + PyPI badges updated
- CHANGELOG.md: callout for the rename + reminder that import path
  stays `socialapis` (independent of the PyPI distribution name)

What did NOT change:
- The Python import path. Users still write `from socialapis import ...`
- The package directory layout (`socialapis/` on disk)
- Any code, any test, any docstring inside the package
- The Pending Trusted Publisher on PyPI is already configured for
  the new `socialapis-sdk` name pointing at this repo's release.yml

Once this lands on main, the v0.1.0 tag can be pushed to trigger
the first release.
@OussemaFr OussemaFr merged commit ff695b3 into main Jun 22, 2026
6 checks passed
@OussemaFr OussemaFr deleted the chore/rename-pypi-to-socialapis-sdk branch June 22, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant