sip-distinfo(1)

πŸ“¦
version 6.16.1 Β· 3 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– sip-distinfo β€” the manual page, but make it a group chat πŸ’–

okay so bestie, this is the sip-distinfo page from the General Commands Manual β€” section 1, commands, you know the vibe. buckle up πŸŽ€


✨ NAME ✨

sip-distinfo β€” create and populate a .dist-info directory 🫢


🌸 SYNOPSIS 🌸

sip-distinfo [options] directory

directory is the full path name of the directory to create. like, the WHOLE path, not a lil shortcut, okay? πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea β˜• β€” sip-distinfo creates and populates a .dist-info directory of an installation or a wheel. it's giving "I got you" energy for build systems that extend the SIP build system and need to create the .dist-info directory from an external tool such as make. no cap πŸ”₯


πŸ’… OPTIONS πŸ’…

  • -h, --help β€” Display a help message. your lil "wait what does this do" safety net πŸ™ˆ
  • -V, --version β€” Display the SIP version number. drop the digits, slay πŸ‘‘
  • --console-script ENTRY-POINT β€” The console entry point ENTRY-POINT is added to the wheel. lowkey important caveat: it is ignored if the --wheel-tag option is not specified. and yes, this option may be specified multiple times. stack 'em πŸ’–
  • --generator NAME β€” If the --wheel-tag option is specified then NAME is written as part of the Generator in the WHEEL file in the .dist-info directory. Otherwise NAME is written to the INSTALLER file. By default sipbuild is written. it's giving "who made this" energy, but make it official ✨
  • --generator-version VERSION β€” VERSION is written as part of the Generator in the WHEEL file in the .dist-info directory. By default the SIP version number is written. so if you don't say anything, SIP just signs its own name, main character behavior honestly 🌈
  • --gui-script ENTRY-POINT β€” The GUI entry point ENTRY-POINT is added to the wheel. same deal as its console sibling: it is ignored if the --wheel-tag option is not specified. This option may be specified multiple times. periodt πŸ’…
  • --inventory FILE β€” FILE contains a list of the relative names of the files, one per line, that comprise the installation or wheel contents. and listen β€” this option must be specified. not optional, not a suggestion, it's required fr fr 🚨
  • --metadata NAME[=VALUE] β€” VALUE is used instead of any value specified for NAME in the [tool.sip.metadata] section of the pyproject.toml file. override moment, we love to see it 😭
  • --prefix DIR β€” This option is provided as an aid to Linux package builders. DIR is used to pass the commonly used values of DESTDIR or INSTALL_ROOT. If specified it should have a trailing native path separator. yes, that trailing separator is a whole thing, don't @ me πŸ“
  • --project-root DIR β€” The name of the directory containing the project's pyproject.toml file is DIR. This option must be specified. again: required. the tool literally needs to know where home is 🏠
  • --requires-dist EXPR β€” EXPR is added to the list of prerequisites written to the METADATA file in the .dist-info directory. It is normally used to specify a particular version of a package project's sip module. This option may be specified multiple times. dependency lore, but make it cute 🧚
  • --sbom FILE β€” Added in version 6.13. ✨

FILE is copied to the sboms subdirectory of the .dist-info directory as defined in PEP 770. FILE may be a glob-style pattern. This option may be specified multiple times. software bill of materials but make it fashion πŸ’€πŸ’–

  • --wheel-tag TAG β€” TAG is written as the Tag in the WHEEL file in the .dist-info directory. this is the option that unlocks the console-script and gui-script girlies, so like... specify it πŸŽ€

bestie reminder: --inventory and --project-root are must-specify options. if you skip them, that's not a vibe, that's a bug in your makefile πŸ’€

and that's the whole page, no notes πŸ‘‘ this was sip-distinfo(1) from the General Commands Manual β€” go forth, populate those .dist-info directories, and stay iconic πŸ¦‹πŸ’œ

πŸ“¦ where this page comes from