============
Installation
============

Stable release from PyPI
========================

.. tab:: Linux/macOS

   .. code-block:: shell

      python3 -m pip install getmac

.. tab:: Windows

   .. code-block:: powershell

      py -m pip install getmac


Debian-based Linux distributions
================================

``apt`` may have it available, depending on the Linux distribution (see packaging status below).

.. code-block:: shell

   sudo apt install getmac


OS Packaging Status
===================

.. image:: https://repology.org/badge/vertical-allrepos/getmac.svg
   :alt: OS Packaging status
   :target: https://repology.org/project/getmac/versions


Latest development version
==========================

.. warning::
   Installing directly from main includes pre-release changes and is not recommended for most users.

This will install the latest version from the main branch on GitHub.

.. tab:: Linux/macOS

   .. code-block:: shell

      python3 -m pip install https://github.com/ghostofgoes/getmac/archive/main.tar.gz

.. tab:: Windows

   .. code-block:: powershell

      py -m pip install https://github.com/ghostofgoes/getmac/archive/main.tar.gz