sip-wheel(1)

💖 sip-wheel(1) 💖

okay bestie, gather round — this is a page from the General Commands Manual, and it's all about sip-wheel, which lives in section 1. Yes, the number in the parentheses is the section, that's just how manpages do. 🎀

---

✨ NAME ✨

sip-wheel — build a wheel for the sip project 🛞✨

---

🌸 SYNOPSIS 🌸

sip-wheel [options]

---

🦋 DESCRIPTION 🦋

So like, sip-wheel creates a wheel — which is a binary distribution, no cap — and that wheel can then be uploaded to PyPI. That's the whole vibe. You build the thing, you ship the thing. 💅

---

👑 OPTIONS 👑

okay this is the long part, but every single one matters, so we're doing all of them. no skimming. periodt. 💖

• -h, --help — shows you a help message. classic. 🫶
• -V, --version — prints the SIP version number. slay.
• --deprecations-are-errors — if you use literally any deprecated feature, it gets treated as an error instead of a warning. dramatic? yes. effective? also yes. 💀
• --quiet — all the progress messages get disabled. silence. 🤫
• --verbose — verbose progress messages get enabled. the opposite vibe. 📢
• --abi-version M[.N] — the version number of the ABI of the sip module you're targeting is M.N. Default? the latest major version. And if you don't give the minor version, it just uses the latest minor version of that major version. so chill of it. ⭐
• --api-dir DIR — a QScintilla .api file gets created in DIR. heads up tho: this has to be a name relative to the directory where the wheel will be installed. 🎀
• --build-dir DIR — DIR gets created as a build directory, and all the generated files go in there. note that this build directory is not removed after the build finishes. by default, a temporary build directory is created instead, and that one does get removed when the build is done. 🧚
• --build-tag TAG — TAG is the build tag used in the name of the wheel. by default the wheel's name has no build tag at all. 🏷️
• --concatenate N — the generated code gets split into N files. by default, one file is generated for each C structure or C++ class. and fr fr, giving a low value of N can significantly speed up the build of large projects. 🔥
• --disable NAME — the NAME bindings are disabled and won't be built. you can pass this option multiple times. it's only available if the project has multiple sets of bindings. 🙈
• --disabled-feature TAG — the TAG feature tag is disabled. also repeatable, also multiple times allowed. ✨
• --enable NAME — the NAME bindings are enabled and will be built. and get this: any associated configuration tests that would normally run to figure out whether the bindings should be built get suppressed entirely. can be specified multiple times, and again, only available if the project contains multiple sets of bindings. 💅
• --no-manylinux — disables manylinux support in the platform tag of a wheel's name. > only use this if you actually need support for older versions of pip. like, genuinely only then.
• --minimum-glibc-version M.N — M.N is the minimum GLIBC version the project requires, written as major and minor version numbers. this is what determines the correct platform tag for Linux wheels. the default GLIBC version is v2.5, which corresponds to manylinux1. it gets ignored if you passed --no-manylinux. 🌈
• --name NAME — NAME is used in the wheel file's name instead of the PyPI project name from the pyproject.toml file. 💖
• --debug — performs a build with debugging symbols. 🐛
• --no-docstrings — turns off generating docstrings that describe the signature of all functions, methods and constructors. 😭
• --pep484-pyi — enables generation of Python type hints stub files. these files describe a module's API and are compliant with PEP 484. ⭐
• --protected-is-public — so SIP can generate code that gives Python access to protected C++ functions. on non-Windows platforms, that code can be avoided if the protected keyword gets redefined as public during compilation — and that can result in a significant reduction in the size of a generated Python module. this option enables the redefinition of protected, and it's the default on every platform except Windows. 👑
• --no-protected-is-public — disables that redefinition of protected (the one that gives Python access to protected C++ functions). this is the default on Windows. 🪟
• --tracing — debugging statements that trace the execution of the bindings get automatically generated. by default they are not generated. 🔍

---

and that's the whole page, bestie. it came from the General Commands Manual — the footer literally just says sip-wheel(1) again, no date, no version number, nothing extra, so that's our lil' sign-off: same name, same section, see u next time. 🎀✨ bye!! 🦋💖