📚 Great if you want to manage files on your BOOX device programmatically, automate uploads/downloads, or plug it into your own tools and scripts.
- Clean and consistent API client for BOOXDrop
- Fully typed (with
pydantic) and 100% modern Python 3.12+ - No external HTTP dependency — bring your own client, if you will
- HTTP client agnostic – plug in your own via simple
HttpClientinterface - Open-source, MIT-licensed, built with readability in mind
configUsers/ endpoints
GET /api/1/configUsers/oneusers/ endpoints
GET /api/1/users/getDevice
GET /api/1/users/me
GET /api/1/users/syncToken
POST /api/1/users/sendVerifyCode
POST /api/1/users/signupByPhoneOrEmailpip install pybooxdropfrom boox import Boox
# Given it is the very first connection, and no token is available:
with Boox(base_url="https://eur.boox.com") as client:
payload = {"mobi": "foo@bar.com"}
_ = client.users.send_verification_code(payload=payload)
# OR, if you don't want to use the context manager
client = Boox(base_url="https://eur.boox.com")
payload = {"mobi": "foo@bar.com"}
_ = client.users.send_verification_code(payload=payload)
client.close()Boox lets you plug in your own HTTP client.
To do this, implement a simple HttpClient protocol with the required methods and pass your adapter to Boox.
Example
import httpx
from boox import Boox, HttpClient
class MyAdapter(HttpClient):
def post(self, url: str, json: dict | None = None) -> Any:
# your logic using requests, httpx, or anything else
...
with Boox(client=MyAdapter(httpx.Client())) as boox: ...Why? This gives you full control over things like:
- ⏰ timeouts
- ♻️ retries
- 🧾 logging
- 🌍 proxies or custom headers
- 🔐 session/cookie handling
By design, Boox does not depend on any specific HTTP library. It only uses Python’s built-in
urllibby default — you're free to userequests,httpx, or your own logic.
# to run all but e2e tests do the following:
uv sync --locked
uv run pytestAlternatively, use:
make testPlease note that since the E2E tests are heavy, require real internet connection, and they connect with the real BOOXDrop server, it is not recommended to run them often.
# required environment variables:
# E2E_SMTP_EMAIL - the e-mail address on smtp.dev
# E2E_SMTP_X_API_KEY - the X-API-KEY for the account
# E2E_TARGET_DOMAIN - the target BOOXDrop domain, e.g. push.boox.com
uv sync --locked
uv run pytest -m e2e --e2eAlternatively, use:
make e2eE2E_SMTP_EMAILmust lead to an e-mail that is connected to a real Boox account. It must be verified prior to the tests.E2E_TARGET_DOMAINis the domain that the Boox account is used with. AFAIK it can be any Boox' domain, because the account is not bound to any in particular. This might change in the future though, so I would rather play safe there.E2E_SMTP_X_API_KEYrelates toX-API-KEYfor SMTP.dev. It is required, as this is the client that is being used. Currently there are no plans to support other providers.
To save time and resources, before each commit or push (especially before you create a PR), please run these commands:
uv sync --locked
uv run ruff check --no-fix
uv run basedpyright
uv run coverage run -m pytest
uv run coverage reportAlternatively, use:
make qaGot ideas, feedback, or feature requests? Feel free to open an issue or pull request!
Contributions are welcome!
- Please fork the repository and create a branch for your feature or bugfix.
- Use
pytestto run tests and add new tests when applicable. - Follow the existing code style, checked by
ruffandbasedpyright. - Open a pull request with a clear description of your changes.
Big thanks to hrw for the project onyx-send2boox. The project was the main inspiration behind this library. While pyBooxDrop is a fresh, focused take on just the API, this project wouldn’t exist without this awesome groundwork.
Thanks for the great job!
MIT – use it, hack it, ship it.