sip-install(1)

📦
version 6.16.1 · 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💅 sip-install(1) — General Commands Manual 🎀

okay so bestie, this is sip-install, a page from the General Commands Manual, and it's literally about building and installing your sip project. no cap. let's get into it ✨

🌸 NAME 🌸

sip-install — build and install the sip project 🫶

🦋 SYNOPSIS 🦋

sip-install [options]

like... that's it. that's the whole vibe. just options, no positional args, she's simple 💅

⭐ DESCRIPTION ⭐

sip-install builds and installs a project. periodt. 🎀

✨ OPTIONS ✨

  • -h, --help — shows you a help message. your bestie when you're lost 🫶
  • -V, --version — prints the SIP version number. iconic for bug reports fr fr
  • --deprecations-are-errors — if you use any deprecated feature, it gets treated as an error instead of a lil warning. so dramatic. so strict. love that for you 💀
  • --quiet — turns off all the progress messages. silence. peace. 🧘
  • --verbose — turns on the verbose progress messages. she's chatty now, and honestly? we love a yapper 💖
  • --abi-version M[.N] — the version number of the ABI of the sip module you're targeting is M.N. by default the latest major version is used. if you don't give the minor version, then the latest minor version of that major version gets used. iykyk ✨
  • --api-dir DIR — a QScintilla .api file gets created in DIR. 🎀
  • --build-dir DIR — DIR gets created as a build directory, and all the generated files land in there. important: this build directory is not removed once the build is done. by default a temporary build directory is created, and that one gets removed after the build completes. so if you want to snoop on the artifacts, this is your moment 👀
  • --concatenate N — the generated code gets split into N files. by default one file is generated for each C structure or C++ class. setting a low value of N can significantly speed up the build of large projects. big brain energy 🔥
  • --disable NAME — the NAME bindings are disabled and will not be built. you can pass this option multiple times. heads up though: it's only available if the project contains multiple sets of bindings. 🙈
  • --disabled-feature TAG — the TAG feature tag is disabled. you can pass this one multiple times too. 💜
  • --enable NAME — the NAME bindings are enabled and will be built. any associated configuration tests that would normally run to decide whether the bindings should be built are suppressed. also specifiable multiple times. also only available if the project contains multiple sets of bindings. 💅
  • --debug — performs a build with debugging symbols. for when you need to see everything 🦋
  • --no-docstrings — disables the generation of docstrings that describe the signature of all functions, methods and constructors. rip docs 😭
  • --no-distinfo — disables the creation of the .dist-info directory. 🎀
  • --pep484-pyi — enables the generation of Python type hints stub files. these files contain a description of a module's API that's compliant with PEP 484. slay ⭐
  • --protected-is-public — okay so, SIP can generate code that gives access to protected C++ functions from Python. on non-Windows platforms, that code can be avoided if the protected keyword is redefined as public during compilation, and that can seriously shrink the size of a generated Python module. this option enables the redefinition of protected, and it's the default on all platforms except Windows. 👑
  • --no-protected-is-public — this disables the redefinition of protected to access protected C++ functions from Python. it's the default on Windows. 🪟
  • --scripts-dir DIR — any project scripts get installed in DIR. if DIR is relative, it's taken as relative to the target directory. by default, the directory containing the Python interpreter is used. 🐍
  • --target-dir DIR — the project gets installed in DIR. by default it's the site-packages directory of the Python installation. 💖
  • --tracing — debugging statements that trace the execution of the bindings are automatically generated. by default those statements are not generated. for the girlies who need to watch the whole plot unfold 🔍
ngl bestie, that --build-dir one is the sneaky one — the default temp dir vanishes after the build, so if you wanted to keep your generated files, say so explicitly or they're gone gone 💀

and that's the whole page, fr fr. this was sip-install(1) from the General Commands Manual — the footer only ever says sip-install(1), so no date or version to drop here, just the page name itself 🎀 mwah, go build something cute 💅✨

📦 where this page comes from