Rename package to convex-sdk (PyPI distribution + import package)

- PyPI distribution: convex-api-py -> convex-sdk
- Import package: convex_api -> convex_sdk (pip install convex-sdk; import convex_sdk)
- GitHub repository stays convex-api-py; predecessor PyPI package frozen at 0.3.1
- Repoint publish workflow, docs and README at the new name
- Exclude tests from the built wheel (find_packages exclude)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: mikera

.bumpversion.cfg

@@ -7,7 +7,7 @@ tag = True
 search = version='{current_version}'
 replace = version='{new_version}'
 
-[bumpversion:file:convex_api/__init__.py]
+[bumpversion:file:convex_sdk/__init__.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 

.github/PUBLISHING.md

@@ -1,23 +1,24 @@
-# Publishing `convex-api-py` to PyPI
+# Publishing `convex-sdk` to PyPI
 
 Releases publish via **PyPI Trusted Publishing** (OIDC) — no API token or secret is
 stored in GitHub. The workflow (`.github/workflows/publish.yml`) is ready but **inert**
 until a trusted publisher is configured on PyPI (one-time setup below).
 
 ## One-time setup on PyPI
 
-1. Sign in at <https://pypi.org> as a maintainer of the `convex-api-py` project.
+1. Sign in at <https://pypi.org> as a maintainer of the `convex-sdk` project.
 2. Go to the project → **Settings → Publishing** (or
-   <https://pypi.org/manage/project/convex-api-py/settings/publishing/>).
+   <https://pypi.org/manage/project/convex-sdk/settings/publishing/>).
 3. Under **Add a new trusted publisher → GitHub**, fill in:
    - **Owner:** `Convex-Dev`
    - **Repository:** `convex-api-py`
    - **Workflow name:** `publish.yml`
    - **Environment:** `pypi`
 4. Save.
 
-> The package already exists on PyPI (`convex-api-py` 0.3.1), so no manual bootstrap
-> publish is needed — just configure the publisher above.
+> `convex-sdk` is a fresh PyPI project; the trusted publisher above authorises the first
+> tagged release to create and populate it — no manual bootstrap publish is needed. (The
+> predecessor package `convex-api-py` remains frozen at 0.3.1.)
 
 Optionally protect the `pypi` GitHub environment
 (repo **Settings → Environments → pypi**) with required reviewers so a human approves
@@ -30,7 +31,7 @@ each release.
    ```bash
    bumpversion patch   # or: minor / major
    ```
-   `bumpversion` updates `setup.py` + `convex_api/__init__.py`, commits, and creates a
+   `bumpversion` updates `setup.py` + `convex_sdk/__init__.py`, commits, and creates a
    `v{version}` tag (see `.bumpversion.cfg`).
 3. Push the tag:
    ```bash

.github/workflows/publish.yml

@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/project/convex-api-py/
+      url: https://pypi.org/project/convex-sdk/
     permissions:
       id-token: write  # Required for PyPI trusted publishing (OIDC)
     steps:

CHANGELOG.md

@@ -1,10 +1,11 @@
 ## Change log
 
 ### 0.3.2
-+   Fix malformed `__version__` string in `convex_api/__init__.py` (also restores `bumpversion` matching)
++   **Renamed package to `convex-sdk`** — PyPI distribution `convex-api-py` → `convex-sdk` and import package `convex_api` → `convex_sdk` (`pip install convex-sdk`; `import convex_sdk`). The GitHub repository stays `convex-api-py`; the predecessor `convex-api-py` PyPI package remains frozen at 0.3.1.
++   Fix malformed `__version__` string in `convex_sdk/__init__.py` (also restores `bumpversion` matching)
 +   Fix `KeyPair.remove_0x_prefix` to pass `re.IGNORECASE` as `flags` (it was silently passed as `count`, so `0X` prefixes were not stripped)
 +   Surface CVM errors returned from `transaction/prepare` as `ConvexAPIError`, consistent with submit and query
-+   Correct README examples (`KeyPair()` not `KeyPair.create()`, `convex` variable name, `convex_api` import path, `Account(...)` constructor, real account-info fields) and the `pip install convex-api-py` package name
++   Correct README examples (`KeyPair()` not `KeyPair.create()`, `convex` variable name, `Account(...)` constructor, real account-info fields)
 +   Add PyPI trusted-publishing release workflow (`.github/workflows/publish.yml`, fires on `v*` tags) and remove the stale commented-out publish block from the docs deploy workflow; see `.github/PUBLISHING.md`
 +   Bump development status classifier from Pre-Alpha to Beta and declare Python 3.11–3.13 support
 

Makefile

@@ -7,7 +7,7 @@
 
 IGNORE_VENV ?= FALSE
 
-PACKAGE_FOLDERS = convex_api tools tests
+PACKAGE_FOLDERS = convex_sdk tools tests
 
 FLAKE8_PARAMETERS = --max-line-length=132 --statistics $(PACKAGE_FOLDERS)
 

README.md

@@ -2,7 +2,7 @@
 
 ![](https://github.com/Convex-Dev/convex-api-py/workflows/testing/badge.svg)
 [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
-[![PyPI version](https://badge.fury.io/py/convex-api-py.svg)](https://badge.fury.io/py/convex-api-py)
+[![PyPI version](https://badge.fury.io/py/convex-sdk.svg)](https://badge.fury.io/py/convex-sdk)
 
 The official Python client library for interacting with the [Convex](https://convex.world) decentralised lattice network.
 
@@ -18,13 +18,13 @@ The official Python client library for interacting with the [Convex](https://con
 ## Installation
 
 ```bash
-pip install convex-api-py
+pip install convex-sdk
 ```
 
 ## Quick Example
 
 ```python
-from convex_api import Convex, KeyPair
+from convex_sdk import Convex, KeyPair
 
 # Connect to the network
 convex = Convex('https://peer.convex.live')
@@ -44,7 +44,7 @@ print(f'Balance: {balance / 1_000_000_000} Convex Coins')
 ## Resources
 
 - **[Official Documentation](https://docs.convex.world/docs/tutorial/client-sdks/python)** - Complete SDK guide
-- **[PyPI Package](https://pypi.org/project/convex-api-py/)** - Python Package Index
+- **[PyPI Package](https://pypi.org/project/convex-sdk/)** - Python Package Index
 - **[Convex Network](https://convex.world)** - Main website
 - **[Discord Community](https://discord.com/invite/xfYGq4CT7v)** - Get help and share ideas
 
@@ -119,13 +119,13 @@ deactivate
 
 ### Quick Start
 
-First you need to download the Convex-API-py package from the python package index PyPi.
+First you need to download the convex-sdk package from the python package index PyPi.
 
-    pip install convex-api-py
+    pip install convex-sdk
 
 You can now access the convex network, and get a balance from an existing account on the network by doing the following:
 
-    >>> from convex_api import Convex, KeyPair
+    >>> from convex_sdk import Convex, KeyPair
     >>> convex = Convex('https://peer.convex.live')
     >>> convex.get_balance(9)
     99396961137042
@@ -155,7 +155,7 @@ You can export the accounts private key encoded as PKCS8 encrypt the key with a
 
 To re-use your account again you need to import the encrypted private key and set the correct account address
 
-    >>> from convex_api import Account, KeyPair
+    >>> from convex_sdk import Account, KeyPair
     >>> key_pair = KeyPair.import_from_file('my_key.dat', 'secret')
     >>> account = Account(key_pair, 809)
 

convex_api/__init__.py

@@ -0,0 +1,12 @@
+"""
+
+    Convex API Python Library
+
+"""
+
+from convex_sdk.account import Account                   # type: ignore # noqa: F401
+from convex_sdk.convex import Convex                     # type: ignore # noqa: F401
+from convex_sdk.contract import Contract                 # type: ignore # noqa: F401
+from convex_sdk.key_pair import KeyPair                  # type: ignore # noqa: F401
+
+__version__ = '0.3.2'

convex_sdk/__init__.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 import re
-from convex_api.key_pair import KeyPair
+from convex_sdk.key_pair import KeyPair
 
 
 class Account:
@@ -61,7 +61,7 @@ def __init__(self, key_pair: KeyPair, address: Account | int | str, name: str |
         .. code-block:: python
 
             >>> # import convex-api
-            >>> from convex_api import Convex, KeyPair, Account
+            >>> from convex_sdk import Convex, KeyPair, Account
 
             >>> # setup the network connection
             >>> convex = Convex('https://convex.world')

convex_api/account.py convex_sdk/account.pyconvex_api/account.py renamed to convex_sdk/account.py

@@ -9,11 +9,11 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from convex_api.convex import Convex
+    from convex_sdk.convex import Convex
 
 import re
 
-from convex_api.account import Account
+from convex_sdk.account import Account
 
 
 class Contract: