extra-platforms


Nameextra-platforms JSON
Version 4.1.0 PyPI version JSON
download
home_pageNone
SummaryDetect platforms and group them by family
upload_time2025-10-21 18:17:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords alt linux amazon linux android arch linux at&t system five azure pipelines bamboo buildkite buildroot centos circle ci cirrus ci cloudlinux os codebuild cygwin debian exherbo linux fedora freebsd gentoo linux github actions runner gitlab ci gnu/hurd guix system heroku ci ibm aix ibm powerkvm kvm for ibm z systems linux mint macos mageia mandriva linux midnightbsd multiplatform netbsd nobara openbsd opensuse opensuse tumbleweed oracle linux os detection parallels pidora platform detection pytest raspbian redhat enterprise linux rocky linux scientific linux slackware solaris sunos suse linux enterprise server teamcity travis ci tuxedo os ubuntu unix windows windows subsystem for linux xenserver
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Extra Platforms

[![Last release](https://img.shields.io/pypi/v/extra-platforms.svg)](https://pypi.python.org/pypi/extra-platforms)
[![Python versions](https://img.shields.io/pypi/pyversions/extra-platforms.svg)](https://pypi.python.org/pypi/extra-platforms)
[![Downloads](https://static.pepy.tech/badge/extra_platforms/month)](https://pepy.tech/project/extra_platforms)
[![Unittests status](https://github.com/kdeldycke/extra-platforms/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/kdeldycke/extra-platforms/actions/workflows/tests.yaml?query=branch%3Amain)
[![Coverage status](https://codecov.io/gh/kdeldycke/extra-platforms/branch/main/graph/badge.svg)](https://app.codecov.io/gh/kdeldycke/extra-platforms)
[![Documentation status](https://github.com/kdeldycke/extra-platforms/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/kdeldycke/extra-platforms/actions/workflows/docs.yaml?query=branch%3Amain)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13341712.svg)](https://doi.org/10.5281/zenodo.13341712)

## What is Extra Platforms?

- Provides a list of all known platforms
- Detect the current platform, at the distribution level
- Platform metadata (version, codename, etc.)
- Group platforms into families
- Manage collection of platforms and groups
- Associate each platform and group to an emoji symbol
- Conditional markers decorators for `pytest`: `@skip_<id>`/`@unless_<id>` for each platform and group (`@skip_android`, `@skip_any_windows`, `@skip_github_ci`, …)
- Fix [`distro#177` issue (support for Windows and Mac OS)](https://github.com/python-distro/distro/issues/177)

## Quick start

If you want to play with this library without contaminating your system, you can [use `uv`](https://docs.astral.sh/uv/guides/tools/#running-tools):

```shell-session
$ uvx --with extra-platforms python
```
```pycon
>>> import extra_platforms

>>> extra_platforms.__version__
'3.2.3'
```

## Examples

Get the current platform, from which you can access lots of metadata:

```pycon
>>> from extra_platforms import current_os

>>> my_os = current_os()
>>> my_os
Platform(id='macos', name='macOS', current=True)

>>> my_os.id
'macos'
>>> my_os.name
'macOS'
>>> my_os.icon
'🍎'

>>> my_os.info()
{
    "id": "macos",
    "name": "macOS",
    "icon": "🍎",
    "current": True,
    "distro_id": "darwin",
    "version": "23.6.0",
    "version_parts": {"major": "23", "minor": "6", "build_number": "0"},
    "like": None,
    "codename": None,
}
```

Check if a platform is a specific system:

```pycon
>>> from extra_platforms import is_gentoo

>>> is_gentoo()
False
```

Use groups to check if the current platform is part of a specific family:

```pycon
>>> from extra_platforms import UNIX, current_os

>>> current_os() in UNIX
False
```

Or directly use the boolean variables available for each family:

```pycon
>>> from extra_platforms import is_unix

>>> is_unix()
False
```

List all platforms of a family:

```pycon
>>> from extra_platforms import LINUX

>>> LINUX
Group(id='linux', name='Any Linux', platform_ids=frozenset({'ibm_powerkvm', 'rocky', 'debian', 'tuxedo', 'ubuntu', 'mageia', 'xenserver', 'opensuse', 'nobara', 'buildroot', 'rhel', 'parallels', 'pidora', 'sles', 'amzn', 'scientific', 'linuxmint', 'centos', 'android', 'gentoo', 'raspbian', 'unknown_linux', 'mandriva', 'exherbo', 'cloudlinux', 'fedora', 'guix', 'arch', 'altlinux', 'slackware', 'oracle', 'kvmibm'}))

>>> print("\n".join([p.name for p in LINUX]))
ALT Linux
Amazon Linux
Android
Arch Linux
Buildroot
CentOS
CloudLinux OS
Debian
Exherbo Linux
Fedora
Gentoo Linux
Guix System
IBM PowerKVM
KVM for IBM z Systems
Linux Mint
Mageia
Mandriva Linux
Nobara
openSUSE
Oracle Linux
Parallels
Pidora
Raspbian
RedHat Enterprise Linux
Rocky Linux
Scientific Linux
Slackware
SUSE Linux Enterprise Server
Tuxedo OS
Ubuntu
Unknown Linux
XenServer
```

Reduce a disparate collection of groups and platforms into a minimal descriptive set, by grouping all platforms into families:

```pycon
>>> from extra_platforms import AIX, MACOS, SOLARIS, reduce

>>> reduce([AIX, MACOS])
{
    Platform(id='aix', name='IBM AIX', current=False),
    Platform(id='macos', name='macOS', current=True),
}

>>> reduce([AIX, MACOS, SOLARIS])
{
    Group(id='system_v', name='Any Unix derived from AT&T System Five', platform_ids=frozenset({'aix', 'solaris'})),
    Platform(id='macos', name='macOS', current=True),
}
```

## Groups β†’ Platforms mapping

Relationships between groups and platforms (excluding the all-encompassing `ALL_PLATFORMS` group), represented as a Sankey diagram.

<!-- platform-sankey-start -->

```mermaid
---
config: {"sankey": {"showValues": false, "width": 800, "height": 400}}
---
sankey-beta

ALL_PLATFORMS_WITHOUT_CI,aix,1
ALL_PLATFORMS_WITHOUT_CI,altlinux,1
ALL_PLATFORMS_WITHOUT_CI,amzn,1
ALL_PLATFORMS_WITHOUT_CI,android,1
ALL_PLATFORMS_WITHOUT_CI,arch,1
ALL_PLATFORMS_WITHOUT_CI,buildroot,1
ALL_PLATFORMS_WITHOUT_CI,centos,1
ALL_PLATFORMS_WITHOUT_CI,cloudlinux,1
ALL_PLATFORMS_WITHOUT_CI,cygwin,1
ALL_PLATFORMS_WITHOUT_CI,debian,1
ALL_PLATFORMS_WITHOUT_CI,exherbo,1
ALL_PLATFORMS_WITHOUT_CI,fedora,1
ALL_PLATFORMS_WITHOUT_CI,freebsd,1
ALL_PLATFORMS_WITHOUT_CI,gentoo,1
ALL_PLATFORMS_WITHOUT_CI,guix,1
ALL_PLATFORMS_WITHOUT_CI,hurd,1
ALL_PLATFORMS_WITHOUT_CI,ibm_powerkvm,1
ALL_PLATFORMS_WITHOUT_CI,kvmibm,1
ALL_PLATFORMS_WITHOUT_CI,linuxmint,1
ALL_PLATFORMS_WITHOUT_CI,macos,1
ALL_PLATFORMS_WITHOUT_CI,mageia,1
ALL_PLATFORMS_WITHOUT_CI,mandriva,1
ALL_PLATFORMS_WITHOUT_CI,midnightbsd,1
ALL_PLATFORMS_WITHOUT_CI,netbsd,1
ALL_PLATFORMS_WITHOUT_CI,nobara,1
ALL_PLATFORMS_WITHOUT_CI,openbsd,1
ALL_PLATFORMS_WITHOUT_CI,opensuse,1
ALL_PLATFORMS_WITHOUT_CI,oracle,1
ALL_PLATFORMS_WITHOUT_CI,parallels,1
ALL_PLATFORMS_WITHOUT_CI,pidora,1
ALL_PLATFORMS_WITHOUT_CI,raspbian,1
ALL_PLATFORMS_WITHOUT_CI,rhel,1
ALL_PLATFORMS_WITHOUT_CI,rocky,1
ALL_PLATFORMS_WITHOUT_CI,scientific,1
ALL_PLATFORMS_WITHOUT_CI,slackware,1
ALL_PLATFORMS_WITHOUT_CI,sles,1
ALL_PLATFORMS_WITHOUT_CI,solaris,1
ALL_PLATFORMS_WITHOUT_CI,sunos,1
ALL_PLATFORMS_WITHOUT_CI,tumbleweed,1
ALL_PLATFORMS_WITHOUT_CI,tuxedo,1
ALL_PLATFORMS_WITHOUT_CI,ubuntu,1
ALL_PLATFORMS_WITHOUT_CI,unknown_linux,1
ALL_PLATFORMS_WITHOUT_CI,windows,1
ALL_PLATFORMS_WITHOUT_CI,wsl1,1
ALL_PLATFORMS_WITHOUT_CI,wsl2,1
ALL_PLATFORMS_WITHOUT_CI,xenserver,1
UNIX,aix,1
UNIX,altlinux,1
UNIX,amzn,1
UNIX,android,1
UNIX,arch,1
UNIX,buildroot,1
UNIX,centos,1
UNIX,cloudlinux,1
UNIX,cygwin,1
UNIX,debian,1
UNIX,exherbo,1
UNIX,fedora,1
UNIX,freebsd,1
UNIX,gentoo,1
UNIX,guix,1
UNIX,hurd,1
UNIX,ibm_powerkvm,1
UNIX,kvmibm,1
UNIX,linuxmint,1
UNIX,macos,1
UNIX,mageia,1
UNIX,mandriva,1
UNIX,midnightbsd,1
UNIX,netbsd,1
UNIX,nobara,1
UNIX,openbsd,1
UNIX,opensuse,1
UNIX,oracle,1
UNIX,parallels,1
UNIX,pidora,1
UNIX,raspbian,1
UNIX,rhel,1
UNIX,rocky,1
UNIX,scientific,1
UNIX,slackware,1
UNIX,sles,1
UNIX,solaris,1
UNIX,sunos,1
UNIX,tumbleweed,1
UNIX,tuxedo,1
UNIX,ubuntu,1
UNIX,unknown_linux,1
UNIX,wsl1,1
UNIX,wsl2,1
UNIX,xenserver,1
UNIX_WITHOUT_MACOS,aix,1
UNIX_WITHOUT_MACOS,altlinux,1
UNIX_WITHOUT_MACOS,amzn,1
UNIX_WITHOUT_MACOS,android,1
UNIX_WITHOUT_MACOS,arch,1
UNIX_WITHOUT_MACOS,buildroot,1
UNIX_WITHOUT_MACOS,centos,1
UNIX_WITHOUT_MACOS,cloudlinux,1
UNIX_WITHOUT_MACOS,cygwin,1
UNIX_WITHOUT_MACOS,debian,1
UNIX_WITHOUT_MACOS,exherbo,1
UNIX_WITHOUT_MACOS,fedora,1
UNIX_WITHOUT_MACOS,freebsd,1
UNIX_WITHOUT_MACOS,gentoo,1
UNIX_WITHOUT_MACOS,guix,1
UNIX_WITHOUT_MACOS,hurd,1
UNIX_WITHOUT_MACOS,ibm_powerkvm,1
UNIX_WITHOUT_MACOS,kvmibm,1
UNIX_WITHOUT_MACOS,linuxmint,1
UNIX_WITHOUT_MACOS,mageia,1
UNIX_WITHOUT_MACOS,mandriva,1
UNIX_WITHOUT_MACOS,midnightbsd,1
UNIX_WITHOUT_MACOS,netbsd,1
UNIX_WITHOUT_MACOS,nobara,1
UNIX_WITHOUT_MACOS,openbsd,1
UNIX_WITHOUT_MACOS,opensuse,1
UNIX_WITHOUT_MACOS,oracle,1
UNIX_WITHOUT_MACOS,parallels,1
UNIX_WITHOUT_MACOS,pidora,1
UNIX_WITHOUT_MACOS,raspbian,1
UNIX_WITHOUT_MACOS,rhel,1
UNIX_WITHOUT_MACOS,rocky,1
UNIX_WITHOUT_MACOS,scientific,1
UNIX_WITHOUT_MACOS,slackware,1
UNIX_WITHOUT_MACOS,sles,1
UNIX_WITHOUT_MACOS,solaris,1
UNIX_WITHOUT_MACOS,sunos,1
UNIX_WITHOUT_MACOS,tumbleweed,1
UNIX_WITHOUT_MACOS,tuxedo,1
UNIX_WITHOUT_MACOS,ubuntu,1
UNIX_WITHOUT_MACOS,unknown_linux,1
UNIX_WITHOUT_MACOS,wsl1,1
UNIX_WITHOUT_MACOS,wsl2,1
UNIX_WITHOUT_MACOS,xenserver,1
LINUX_LIKE,altlinux,1
LINUX_LIKE,amzn,1
LINUX_LIKE,android,1
LINUX_LIKE,arch,1
LINUX_LIKE,buildroot,1
LINUX_LIKE,centos,1
LINUX_LIKE,cloudlinux,1
LINUX_LIKE,debian,1
LINUX_LIKE,exherbo,1
LINUX_LIKE,fedora,1
LINUX_LIKE,gentoo,1
LINUX_LIKE,guix,1
LINUX_LIKE,ibm_powerkvm,1
LINUX_LIKE,kvmibm,1
LINUX_LIKE,linuxmint,1
LINUX_LIKE,mageia,1
LINUX_LIKE,mandriva,1
LINUX_LIKE,nobara,1
LINUX_LIKE,opensuse,1
LINUX_LIKE,oracle,1
LINUX_LIKE,parallels,1
LINUX_LIKE,pidora,1
LINUX_LIKE,raspbian,1
LINUX_LIKE,rhel,1
LINUX_LIKE,rocky,1
LINUX_LIKE,scientific,1
LINUX_LIKE,slackware,1
LINUX_LIKE,sles,1
LINUX_LIKE,tumbleweed,1
LINUX_LIKE,tuxedo,1
LINUX_LIKE,ubuntu,1
LINUX_LIKE,unknown_linux,1
LINUX_LIKE,wsl1,1
LINUX_LIKE,wsl2,1
LINUX_LIKE,xenserver,1
LINUX,altlinux,1
LINUX,amzn,1
LINUX,android,1
LINUX,arch,1
LINUX,buildroot,1
LINUX,centos,1
LINUX,cloudlinux,1
LINUX,debian,1
LINUX,exherbo,1
LINUX,fedora,1
LINUX,gentoo,1
LINUX,guix,1
LINUX,ibm_powerkvm,1
LINUX,kvmibm,1
LINUX,linuxmint,1
LINUX,mageia,1
LINUX,mandriva,1
LINUX,nobara,1
LINUX,opensuse,1
LINUX,oracle,1
LINUX,parallels,1
LINUX,pidora,1
LINUX,raspbian,1
LINUX,rhel,1
LINUX,rocky,1
LINUX,scientific,1
LINUX,slackware,1
LINUX,sles,1
LINUX,tumbleweed,1
LINUX,tuxedo,1
LINUX,ubuntu,1
LINUX,unknown_linux,1
LINUX,xenserver,1
CI,azure_pipelines,1
CI,bamboo,1
CI,buildkite,1
CI,circle_ci,1
CI,cirrus_ci,1
CI,codebuild,1
CI,github_ci,1
CI,gitlab_ci,1
CI,heroku_ci,1
CI,teamcity,1
CI,travis_ci,1
CI,unknown_ci,1
BSD,freebsd,1
BSD,macos,1
BSD,midnightbsd,1
BSD,netbsd,1
BSD,openbsd,1
BSD,sunos,1
BSD_WITHOUT_MACOS,freebsd,1
BSD_WITHOUT_MACOS,midnightbsd,1
BSD_WITHOUT_MACOS,netbsd,1
BSD_WITHOUT_MACOS,openbsd,1
BSD_WITHOUT_MACOS,sunos,1
SYSTEM_V,aix,1
SYSTEM_V,solaris,1
LINUX_LAYERS,wsl1,1
LINUX_LAYERS,wsl2,1
UNIX_LAYERS,cygwin,1
OTHER_UNIX,hurd,1
ANY_WINDOWS,windows,1
```

<!-- platform-sankey-end -->

## OS families

Each platform is assigned to a group of non-overlpaping families:

<!-- platform-hierarchy-start -->

```mermaid
---
config: {"mindmap": {"padding": 5}}
---
mindmap
    ((Extra Platforms))
        )≛ UNIX_LAYERS(
            (ΟΎ cygwin)
        )β…€ SYSTEM_V(
            (➿ aix)
            (🌞 solaris)
        )⊎ OTHER_UNIX(
            (πŸƒ hurd)
        )β‰š LINUX_LAYERS(
            (⊞ wsl1)
            (⊞ wsl2)
        )🐧 LINUX(
            (🐧 altlinux)
            (πŸ™‚ amzn)
            (πŸ€– android)
            (πŸŽ—οΈ arch)
            (⛑️ buildroot)
            (πŸ’  centos)
            (꩜ cloudlinux)
            (πŸŒ€ debian)
            (🐽 exherbo)
            (🎩 fedora)
            (πŸ—œοΈ gentoo)
            (πŸƒ guix)
            (🀹 ibm_powerkvm)
            (🀹 kvmibm)
            (🌿 linuxmint)
            (β₯ mageia)
            (πŸ’« mandriva)
            (οŽ€ nobara)
            (🦎 opensuse)
            (🦴 oracle)
            (βˆ₯ parallels)
            (πŸ“ pidora)
            (πŸ“ raspbian)
            (🎩 rhel)
            (⛰️ rocky)
            (βš›οΈ scientific)
            (🚬 slackware)
            (🦎 sles)
            (↻ tumbleweed)
            (🀡 tuxedo)
            (🎯 ubuntu)
            (🐧 unknown_linux)
            (Ⓧ xenserver)
        )β™Ί CI(
            (═ azure_pipelines)
            (⟲ bamboo)
            (πŸͺ buildkite)
            (βͺΎ circle_ci)
            (≋ cirrus_ci)
            (αš™ codebuild)
            (πŸ™ github_ci)
            (🦊 gitlab_ci)
            (β₯ heroku_ci)
            (πŸ™οΈ teamcity)
            (πŸ‘· travis_ci)
            (β™² unknown_ci)
        )πŸ…±οΈ+ BSD(
            (😈 freebsd)
            (🍎 macos)
            (🌘 midnightbsd)
            (🚩 netbsd)
            (🐑 openbsd)
            (β˜€οΈ sunos)
        )πŸͺŸ ANY_WINDOWS(
            (πŸͺŸ windows)
```

<!-- platform-hierarchy-end -->

## Used in

Check these projects to get real-life examples of `extra-platforms` usage:

- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/meta-package-manager?label=%E2%AD%90&style=flat-square) [Meta Package Manager](https://github.com/kdeldycke/meta-package-manager) - A unifying CLI for multiple package managers.
- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/click-extra?label=%E2%AD%90&style=flat-square) [Click Extra](https://github.com/kdeldycke/click-extra) - Drop-in replacement for Click to make user-friendly and colorful CLI.

Feel free to send a PR to add your project in this list if you are relying on Click Extra in any way.

## Development

[Development guidelines](https://github.com/kdeldycke/click-extra?tab=readme-ov-file#development) are the same as [parent project Click Extra](https://github.com/kdeldycke/click-extra), from which `extra-platforms` originated.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "extra-platforms",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "ALT Linux, Amazon Linux, Android, Arch Linux, AT&T System Five, Azure Pipelines, Bamboo, Buildkite, Buildroot, CentOS, Circle CI, Cirrus CI, CloudLinux OS, CodeBuild, Cygwin, Debian, Exherbo Linux, Fedora, FreeBSD, Gentoo Linux, GitHub Actions runner, GitLab CI, GNU/Hurd, Guix System, Heroku CI, IBM AIX, IBM PowerKVM, KVM for IBM z Systems, Linux Mint, macOS, Mageia, Mandriva Linux, MidnightBSD, multiplatform, NetBSD, Nobara, OpenBSD, openSUSE, openSUSE Tumbleweed, Oracle Linux, OS detection, Parallels, Pidora, Platform detection, Pytest, Raspbian, RedHat Enterprise Linux, Rocky Linux, Scientific Linux, Slackware, Solaris, SunOS, SUSE Linux Enterprise Server, TeamCity, Travis CI, Tuxedo OS, Ubuntu, Unix, Windows, Windows Subsystem for Linux, XenServer",
    "author": null,
    "author_email": "Kevin Deldycke <kevin@deldycke.com>",
    "download_url": "https://files.pythonhosted.org/packages/64/a6/3d57168ea92f5c6f78786e8bf20fc5273e679d96c6c7723cf9f2374523c1/extra_platforms-4.1.0.tar.gz",
    "platform": null,
    "description": "# Extra Platforms\n\n[![Last release](https://img.shields.io/pypi/v/extra-platforms.svg)](https://pypi.python.org/pypi/extra-platforms)\n[![Python versions](https://img.shields.io/pypi/pyversions/extra-platforms.svg)](https://pypi.python.org/pypi/extra-platforms)\n[![Downloads](https://static.pepy.tech/badge/extra_platforms/month)](https://pepy.tech/project/extra_platforms)\n[![Unittests status](https://github.com/kdeldycke/extra-platforms/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/kdeldycke/extra-platforms/actions/workflows/tests.yaml?query=branch%3Amain)\n[![Coverage status](https://codecov.io/gh/kdeldycke/extra-platforms/branch/main/graph/badge.svg)](https://app.codecov.io/gh/kdeldycke/extra-platforms)\n[![Documentation status](https://github.com/kdeldycke/extra-platforms/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/kdeldycke/extra-platforms/actions/workflows/docs.yaml?query=branch%3Amain)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13341712.svg)](https://doi.org/10.5281/zenodo.13341712)\n\n## What is Extra Platforms?\n\n- Provides a list of all known platforms\n- Detect the current platform, at the distribution level\n- Platform metadata (version, codename, etc.)\n- Group platforms into families\n- Manage collection of platforms and groups\n- Associate each platform and group to an emoji symbol\n- Conditional markers decorators for `pytest`: `@skip_<id>`/`@unless_<id>` for each platform and group (`@skip_android`, `@skip_any_windows`, `@skip_github_ci`, \u2026)\n- Fix [`distro#177` issue (support for Windows and Mac OS)](https://github.com/python-distro/distro/issues/177)\n\n## Quick start\n\nIf you want to play with this library without contaminating your system, you can [use `uv`](https://docs.astral.sh/uv/guides/tools/#running-tools):\n\n```shell-session\n$ uvx --with extra-platforms python\n```\n```pycon\n>>> import extra_platforms\n\n>>> extra_platforms.__version__\n'3.2.3'\n```\n\n## Examples\n\nGet the current platform, from which you can access lots of metadata:\n\n```pycon\n>>> from extra_platforms import current_os\n\n>>> my_os = current_os()\n>>> my_os\nPlatform(id='macos', name='macOS', current=True)\n\n>>> my_os.id\n'macos'\n>>> my_os.name\n'macOS'\n>>> my_os.icon\n'\ud83c\udf4e'\n\n>>> my_os.info()\n{\n    \"id\": \"macos\",\n    \"name\": \"macOS\",\n    \"icon\": \"\ud83c\udf4e\",\n    \"current\": True,\n    \"distro_id\": \"darwin\",\n    \"version\": \"23.6.0\",\n    \"version_parts\": {\"major\": \"23\", \"minor\": \"6\", \"build_number\": \"0\"},\n    \"like\": None,\n    \"codename\": None,\n}\n```\n\nCheck if a platform is a specific system:\n\n```pycon\n>>> from extra_platforms import is_gentoo\n\n>>> is_gentoo()\nFalse\n```\n\nUse groups to check if the current platform is part of a specific family:\n\n```pycon\n>>> from extra_platforms import UNIX, current_os\n\n>>> current_os() in UNIX\nFalse\n```\n\nOr directly use the boolean variables available for each family:\n\n```pycon\n>>> from extra_platforms import is_unix\n\n>>> is_unix()\nFalse\n```\n\nList all platforms of a family:\n\n```pycon\n>>> from extra_platforms import LINUX\n\n>>> LINUX\nGroup(id='linux', name='Any Linux', platform_ids=frozenset({'ibm_powerkvm', 'rocky', 'debian', 'tuxedo', 'ubuntu', 'mageia', 'xenserver', 'opensuse', 'nobara', 'buildroot', 'rhel', 'parallels', 'pidora', 'sles', 'amzn', 'scientific', 'linuxmint', 'centos', 'android', 'gentoo', 'raspbian', 'unknown_linux', 'mandriva', 'exherbo', 'cloudlinux', 'fedora', 'guix', 'arch', 'altlinux', 'slackware', 'oracle', 'kvmibm'}))\n\n>>> print(\"\\n\".join([p.name for p in LINUX]))\nALT Linux\nAmazon Linux\nAndroid\nArch Linux\nBuildroot\nCentOS\nCloudLinux OS\nDebian\nExherbo Linux\nFedora\nGentoo Linux\nGuix System\nIBM PowerKVM\nKVM for IBM z Systems\nLinux Mint\nMageia\nMandriva Linux\nNobara\nopenSUSE\nOracle Linux\nParallels\nPidora\nRaspbian\nRedHat Enterprise Linux\nRocky Linux\nScientific Linux\nSlackware\nSUSE Linux Enterprise Server\nTuxedo OS\nUbuntu\nUnknown Linux\nXenServer\n```\n\nReduce a disparate collection of groups and platforms into a minimal descriptive set, by grouping all platforms into families:\n\n```pycon\n>>> from extra_platforms import AIX, MACOS, SOLARIS, reduce\n\n>>> reduce([AIX, MACOS])\n{\n    Platform(id='aix', name='IBM AIX', current=False),\n    Platform(id='macos', name='macOS', current=True),\n}\n\n>>> reduce([AIX, MACOS, SOLARIS])\n{\n    Group(id='system_v', name='Any Unix derived from AT&T System Five', platform_ids=frozenset({'aix', 'solaris'})),\n    Platform(id='macos', name='macOS', current=True),\n}\n```\n\n## Groups \u2192 Platforms mapping\n\nRelationships between groups and platforms (excluding the all-encompassing `ALL_PLATFORMS` group), represented as a Sankey diagram.\n\n<!-- platform-sankey-start -->\n\n```mermaid\n---\nconfig: {\"sankey\": {\"showValues\": false, \"width\": 800, \"height\": 400}}\n---\nsankey-beta\n\nALL_PLATFORMS_WITHOUT_CI,aix,1\nALL_PLATFORMS_WITHOUT_CI,altlinux,1\nALL_PLATFORMS_WITHOUT_CI,amzn,1\nALL_PLATFORMS_WITHOUT_CI,android,1\nALL_PLATFORMS_WITHOUT_CI,arch,1\nALL_PLATFORMS_WITHOUT_CI,buildroot,1\nALL_PLATFORMS_WITHOUT_CI,centos,1\nALL_PLATFORMS_WITHOUT_CI,cloudlinux,1\nALL_PLATFORMS_WITHOUT_CI,cygwin,1\nALL_PLATFORMS_WITHOUT_CI,debian,1\nALL_PLATFORMS_WITHOUT_CI,exherbo,1\nALL_PLATFORMS_WITHOUT_CI,fedora,1\nALL_PLATFORMS_WITHOUT_CI,freebsd,1\nALL_PLATFORMS_WITHOUT_CI,gentoo,1\nALL_PLATFORMS_WITHOUT_CI,guix,1\nALL_PLATFORMS_WITHOUT_CI,hurd,1\nALL_PLATFORMS_WITHOUT_CI,ibm_powerkvm,1\nALL_PLATFORMS_WITHOUT_CI,kvmibm,1\nALL_PLATFORMS_WITHOUT_CI,linuxmint,1\nALL_PLATFORMS_WITHOUT_CI,macos,1\nALL_PLATFORMS_WITHOUT_CI,mageia,1\nALL_PLATFORMS_WITHOUT_CI,mandriva,1\nALL_PLATFORMS_WITHOUT_CI,midnightbsd,1\nALL_PLATFORMS_WITHOUT_CI,netbsd,1\nALL_PLATFORMS_WITHOUT_CI,nobara,1\nALL_PLATFORMS_WITHOUT_CI,openbsd,1\nALL_PLATFORMS_WITHOUT_CI,opensuse,1\nALL_PLATFORMS_WITHOUT_CI,oracle,1\nALL_PLATFORMS_WITHOUT_CI,parallels,1\nALL_PLATFORMS_WITHOUT_CI,pidora,1\nALL_PLATFORMS_WITHOUT_CI,raspbian,1\nALL_PLATFORMS_WITHOUT_CI,rhel,1\nALL_PLATFORMS_WITHOUT_CI,rocky,1\nALL_PLATFORMS_WITHOUT_CI,scientific,1\nALL_PLATFORMS_WITHOUT_CI,slackware,1\nALL_PLATFORMS_WITHOUT_CI,sles,1\nALL_PLATFORMS_WITHOUT_CI,solaris,1\nALL_PLATFORMS_WITHOUT_CI,sunos,1\nALL_PLATFORMS_WITHOUT_CI,tumbleweed,1\nALL_PLATFORMS_WITHOUT_CI,tuxedo,1\nALL_PLATFORMS_WITHOUT_CI,ubuntu,1\nALL_PLATFORMS_WITHOUT_CI,unknown_linux,1\nALL_PLATFORMS_WITHOUT_CI,windows,1\nALL_PLATFORMS_WITHOUT_CI,wsl1,1\nALL_PLATFORMS_WITHOUT_CI,wsl2,1\nALL_PLATFORMS_WITHOUT_CI,xenserver,1\nUNIX,aix,1\nUNIX,altlinux,1\nUNIX,amzn,1\nUNIX,android,1\nUNIX,arch,1\nUNIX,buildroot,1\nUNIX,centos,1\nUNIX,cloudlinux,1\nUNIX,cygwin,1\nUNIX,debian,1\nUNIX,exherbo,1\nUNIX,fedora,1\nUNIX,freebsd,1\nUNIX,gentoo,1\nUNIX,guix,1\nUNIX,hurd,1\nUNIX,ibm_powerkvm,1\nUNIX,kvmibm,1\nUNIX,linuxmint,1\nUNIX,macos,1\nUNIX,mageia,1\nUNIX,mandriva,1\nUNIX,midnightbsd,1\nUNIX,netbsd,1\nUNIX,nobara,1\nUNIX,openbsd,1\nUNIX,opensuse,1\nUNIX,oracle,1\nUNIX,parallels,1\nUNIX,pidora,1\nUNIX,raspbian,1\nUNIX,rhel,1\nUNIX,rocky,1\nUNIX,scientific,1\nUNIX,slackware,1\nUNIX,sles,1\nUNIX,solaris,1\nUNIX,sunos,1\nUNIX,tumbleweed,1\nUNIX,tuxedo,1\nUNIX,ubuntu,1\nUNIX,unknown_linux,1\nUNIX,wsl1,1\nUNIX,wsl2,1\nUNIX,xenserver,1\nUNIX_WITHOUT_MACOS,aix,1\nUNIX_WITHOUT_MACOS,altlinux,1\nUNIX_WITHOUT_MACOS,amzn,1\nUNIX_WITHOUT_MACOS,android,1\nUNIX_WITHOUT_MACOS,arch,1\nUNIX_WITHOUT_MACOS,buildroot,1\nUNIX_WITHOUT_MACOS,centos,1\nUNIX_WITHOUT_MACOS,cloudlinux,1\nUNIX_WITHOUT_MACOS,cygwin,1\nUNIX_WITHOUT_MACOS,debian,1\nUNIX_WITHOUT_MACOS,exherbo,1\nUNIX_WITHOUT_MACOS,fedora,1\nUNIX_WITHOUT_MACOS,freebsd,1\nUNIX_WITHOUT_MACOS,gentoo,1\nUNIX_WITHOUT_MACOS,guix,1\nUNIX_WITHOUT_MACOS,hurd,1\nUNIX_WITHOUT_MACOS,ibm_powerkvm,1\nUNIX_WITHOUT_MACOS,kvmibm,1\nUNIX_WITHOUT_MACOS,linuxmint,1\nUNIX_WITHOUT_MACOS,mageia,1\nUNIX_WITHOUT_MACOS,mandriva,1\nUNIX_WITHOUT_MACOS,midnightbsd,1\nUNIX_WITHOUT_MACOS,netbsd,1\nUNIX_WITHOUT_MACOS,nobara,1\nUNIX_WITHOUT_MACOS,openbsd,1\nUNIX_WITHOUT_MACOS,opensuse,1\nUNIX_WITHOUT_MACOS,oracle,1\nUNIX_WITHOUT_MACOS,parallels,1\nUNIX_WITHOUT_MACOS,pidora,1\nUNIX_WITHOUT_MACOS,raspbian,1\nUNIX_WITHOUT_MACOS,rhel,1\nUNIX_WITHOUT_MACOS,rocky,1\nUNIX_WITHOUT_MACOS,scientific,1\nUNIX_WITHOUT_MACOS,slackware,1\nUNIX_WITHOUT_MACOS,sles,1\nUNIX_WITHOUT_MACOS,solaris,1\nUNIX_WITHOUT_MACOS,sunos,1\nUNIX_WITHOUT_MACOS,tumbleweed,1\nUNIX_WITHOUT_MACOS,tuxedo,1\nUNIX_WITHOUT_MACOS,ubuntu,1\nUNIX_WITHOUT_MACOS,unknown_linux,1\nUNIX_WITHOUT_MACOS,wsl1,1\nUNIX_WITHOUT_MACOS,wsl2,1\nUNIX_WITHOUT_MACOS,xenserver,1\nLINUX_LIKE,altlinux,1\nLINUX_LIKE,amzn,1\nLINUX_LIKE,android,1\nLINUX_LIKE,arch,1\nLINUX_LIKE,buildroot,1\nLINUX_LIKE,centos,1\nLINUX_LIKE,cloudlinux,1\nLINUX_LIKE,debian,1\nLINUX_LIKE,exherbo,1\nLINUX_LIKE,fedora,1\nLINUX_LIKE,gentoo,1\nLINUX_LIKE,guix,1\nLINUX_LIKE,ibm_powerkvm,1\nLINUX_LIKE,kvmibm,1\nLINUX_LIKE,linuxmint,1\nLINUX_LIKE,mageia,1\nLINUX_LIKE,mandriva,1\nLINUX_LIKE,nobara,1\nLINUX_LIKE,opensuse,1\nLINUX_LIKE,oracle,1\nLINUX_LIKE,parallels,1\nLINUX_LIKE,pidora,1\nLINUX_LIKE,raspbian,1\nLINUX_LIKE,rhel,1\nLINUX_LIKE,rocky,1\nLINUX_LIKE,scientific,1\nLINUX_LIKE,slackware,1\nLINUX_LIKE,sles,1\nLINUX_LIKE,tumbleweed,1\nLINUX_LIKE,tuxedo,1\nLINUX_LIKE,ubuntu,1\nLINUX_LIKE,unknown_linux,1\nLINUX_LIKE,wsl1,1\nLINUX_LIKE,wsl2,1\nLINUX_LIKE,xenserver,1\nLINUX,altlinux,1\nLINUX,amzn,1\nLINUX,android,1\nLINUX,arch,1\nLINUX,buildroot,1\nLINUX,centos,1\nLINUX,cloudlinux,1\nLINUX,debian,1\nLINUX,exherbo,1\nLINUX,fedora,1\nLINUX,gentoo,1\nLINUX,guix,1\nLINUX,ibm_powerkvm,1\nLINUX,kvmibm,1\nLINUX,linuxmint,1\nLINUX,mageia,1\nLINUX,mandriva,1\nLINUX,nobara,1\nLINUX,opensuse,1\nLINUX,oracle,1\nLINUX,parallels,1\nLINUX,pidora,1\nLINUX,raspbian,1\nLINUX,rhel,1\nLINUX,rocky,1\nLINUX,scientific,1\nLINUX,slackware,1\nLINUX,sles,1\nLINUX,tumbleweed,1\nLINUX,tuxedo,1\nLINUX,ubuntu,1\nLINUX,unknown_linux,1\nLINUX,xenserver,1\nCI,azure_pipelines,1\nCI,bamboo,1\nCI,buildkite,1\nCI,circle_ci,1\nCI,cirrus_ci,1\nCI,codebuild,1\nCI,github_ci,1\nCI,gitlab_ci,1\nCI,heroku_ci,1\nCI,teamcity,1\nCI,travis_ci,1\nCI,unknown_ci,1\nBSD,freebsd,1\nBSD,macos,1\nBSD,midnightbsd,1\nBSD,netbsd,1\nBSD,openbsd,1\nBSD,sunos,1\nBSD_WITHOUT_MACOS,freebsd,1\nBSD_WITHOUT_MACOS,midnightbsd,1\nBSD_WITHOUT_MACOS,netbsd,1\nBSD_WITHOUT_MACOS,openbsd,1\nBSD_WITHOUT_MACOS,sunos,1\nSYSTEM_V,aix,1\nSYSTEM_V,solaris,1\nLINUX_LAYERS,wsl1,1\nLINUX_LAYERS,wsl2,1\nUNIX_LAYERS,cygwin,1\nOTHER_UNIX,hurd,1\nANY_WINDOWS,windows,1\n```\n\n<!-- platform-sankey-end -->\n\n## OS families\n\nEach platform is assigned to a group of non-overlpaping families:\n\n<!-- platform-hierarchy-start -->\n\n```mermaid\n---\nconfig: {\"mindmap\": {\"padding\": 5}}\n---\nmindmap\n    ((Extra Platforms))\n        )\u225b UNIX_LAYERS(\n            (\u03fe cygwin)\n        )\u2164 SYSTEM_V(\n            (\u27bf aix)\n            (\ud83c\udf1e solaris)\n        )\u228e OTHER_UNIX(\n            (\ud83d\udc03 hurd)\n        )\u225a LINUX_LAYERS(\n            (\u229e wsl1)\n            (\u229e wsl2)\n        )\ud83d\udc27 LINUX(\n            (\ud83d\udc27 altlinux)\n            (\ud83d\ude42 amzn)\n            (\ud83e\udd16 android)\n            (\ud83c\udf97\ufe0f arch)\n            (\u26d1\ufe0f buildroot)\n            (\ud83d\udca0 centos)\n            (\uaa5c cloudlinux)\n            (\ud83c\udf00 debian)\n            (\ud83d\udc3d exherbo)\n            (\ud83c\udfa9 fedora)\n            (\ud83d\udddc\ufe0f gentoo)\n            (\ud83d\udc03 guix)\n            (\ud83e\udd39 ibm_powerkvm)\n            (\ud83e\udd39 kvmibm)\n            (\ud83c\udf3f linuxmint)\n            (\u2365 mageia)\n            (\ud83d\udcab mandriva)\n            (\uf380 nobara)\n            (\ud83e\udd8e opensuse)\n            (\ud83e\uddb4 oracle)\n            (\u2225 parallels)\n            (\ud83c\udf53 pidora)\n            (\ud83c\udf53 raspbian)\n            (\ud83c\udfa9 rhel)\n            (\u26f0\ufe0f rocky)\n            (\u269b\ufe0f scientific)\n            (\ud83d\udeac slackware)\n            (\ud83e\udd8e sles)\n            (\u21bb tumbleweed)\n            (\ud83e\udd35 tuxedo)\n            (\ud83c\udfaf ubuntu)\n            (\ud83d\udc27 unknown_linux)\n            (\u24cd xenserver)\n        )\u267a CI(\n            (\u2550 azure_pipelines)\n            (\u27f2 bamboo)\n            (\ud83e\ude81 buildkite)\n            (\u2abe circle_ci)\n            (\u224b cirrus_ci)\n            (\u1699 codebuild)\n            (\ud83d\udc19 github_ci)\n            (\ud83e\udd8a gitlab_ci)\n            (\u2941 heroku_ci)\n            (\ud83c\udfd9\ufe0f teamcity)\n            (\ud83d\udc77 travis_ci)\n            (\u2672 unknown_ci)\n        )\ud83c\udd71\ufe0f+ BSD(\n            (\ud83d\ude08 freebsd)\n            (\ud83c\udf4e macos)\n            (\ud83c\udf18 midnightbsd)\n            (\ud83d\udea9 netbsd)\n            (\ud83d\udc21 openbsd)\n            (\u2600\ufe0f sunos)\n        )\ud83e\ude9f ANY_WINDOWS(\n            (\ud83e\ude9f windows)\n```\n\n<!-- platform-hierarchy-end -->\n\n## Used in\n\nCheck these projects to get real-life examples of `extra-platforms` usage:\n\n- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/meta-package-manager?label=%E2%AD%90&style=flat-square) [Meta Package Manager](https://github.com/kdeldycke/meta-package-manager) - A unifying CLI for multiple package managers.\n- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/click-extra?label=%E2%AD%90&style=flat-square) [Click Extra](https://github.com/kdeldycke/click-extra) - Drop-in replacement for Click to make user-friendly and colorful CLI.\n\nFeel free to send a PR to add your project in this list if you are relying on Click Extra in any way.\n\n## Development\n\n[Development guidelines](https://github.com/kdeldycke/click-extra?tab=readme-ov-file#development) are the same as [parent project Click Extra](https://github.com/kdeldycke/click-extra), from which `extra-platforms` originated.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Detect platforms and group them by family",
    "version": "4.1.0",
    "project_urls": {
        "Changelog": "https://github.com/kdeldycke/extra-platforms/blob/main/changelog.md",
        "Documentation": "https://kdeldycke.github.io/extra-platforms",
        "Funding": "https://github.com/sponsors/kdeldycke",
        "Homepage": "https://github.com/kdeldycke/extra-platforms",
        "Issues": "https://github.com/kdeldycke/extra-platforms/issues",
        "Repository": "https://github.com/kdeldycke/extra-platforms"
    },
    "split_keywords": [
        "alt linux",
        " amazon linux",
        " android",
        " arch linux",
        " at&t system five",
        " azure pipelines",
        " bamboo",
        " buildkite",
        " buildroot",
        " centos",
        " circle ci",
        " cirrus ci",
        " cloudlinux os",
        " codebuild",
        " cygwin",
        " debian",
        " exherbo linux",
        " fedora",
        " freebsd",
        " gentoo linux",
        " github actions runner",
        " gitlab ci",
        " gnu/hurd",
        " guix system",
        " heroku ci",
        " ibm aix",
        " ibm powerkvm",
        " kvm for ibm z systems",
        " linux mint",
        " macos",
        " mageia",
        " mandriva linux",
        " midnightbsd",
        " multiplatform",
        " netbsd",
        " nobara",
        " openbsd",
        " opensuse",
        " opensuse tumbleweed",
        " oracle linux",
        " os detection",
        " parallels",
        " pidora",
        " platform detection",
        " pytest",
        " raspbian",
        " redhat enterprise linux",
        " rocky linux",
        " scientific linux",
        " slackware",
        " solaris",
        " sunos",
        " suse linux enterprise server",
        " teamcity",
        " travis ci",
        " tuxedo os",
        " ubuntu",
        " unix",
        " windows",
        " windows subsystem for linux",
        " xenserver"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f2610f64fe9e26ce1f70838b6e812ec17772e1a673d5e824d766053df98d2cb5",
                "md5": "8bb0b038c2ab20e040eb90394ced5900",
                "sha256": "aaad2438a4ac92df52b8ea6d1b3cc64b018a4f4b9f9cd82c4be48976a501f323"
            },
            "downloads": -1,
            "filename": "extra_platforms-4.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8bb0b038c2ab20e040eb90394ced5900",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 34220,
            "upload_time": "2025-10-21T18:17:06",
            "upload_time_iso_8601": "2025-10-21T18:17:06.288047Z",
            "url": "https://files.pythonhosted.org/packages/f2/61/0f64fe9e26ce1f70838b6e812ec17772e1a673d5e824d766053df98d2cb5/extra_platforms-4.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "64a63d57168ea92f5c6f78786e8bf20fc5273e679d96c6c7723cf9f2374523c1",
                "md5": "b6aa759f5eef61fcbd852038b835a5e4",
                "sha256": "2d99c2fb8fdadeb2e47747c40033465ca551fc57287a547d2de07c0875aefed8"
            },
            "downloads": -1,
            "filename": "extra_platforms-4.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b6aa759f5eef61fcbd852038b835a5e4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 47038,
            "upload_time": "2025-10-21T18:17:07",
            "upload_time_iso_8601": "2025-10-21T18:17:07.637837Z",
            "url": "https://files.pythonhosted.org/packages/64/a6/3d57168ea92f5c6f78786e8bf20fc5273e679d96c6c7723cf9f2374523c1/extra_platforms-4.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-21 18:17:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kdeldycke",
    "github_project": "extra-platforms",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "extra-platforms"
}
        
Elapsed time: 0.69346s