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

ACMAD Upload Helper requires Python 3.12 or later and is published on the
private ACMAD package index.

pip
---

Install the command-line application into an existing environment:

.. code-block:: console

   $ python -m pip install \
       --extra-index-url=https://pypi.acmad.cloud.edu.au/ \
       acmad-upload-helper

uv
--

Add the package to a project:

.. code-block:: console

   $ uv add acmad-upload-helper \
       --extra-index-url=https://pypi.acmad.cloud.edu.au/

Alternatively, install it into the active environment:

.. code-block:: console

   $ uv pip install acmad-upload-helper \
       --extra-index-url=https://pypi.acmad.cloud.edu.au/

Optional desktop interface
--------------------------

The wxPython desktop interface is an optional dependency:

.. code-block:: console

   $ python -m pip install \
       --extra-index-url=https://pypi.acmad.cloud.edu.au/ \
       "acmad-upload-helper[gui]"
   $ acmad-upload-gui

For contributors, ``uv sync --extra gui`` installs the same extra from a
working copy. Building a standalone platform-local application additionally
requires the ``gui-build`` dependency group and a C/C++ toolchain:

.. code-block:: console

   $ uv sync --extra gui --group gui-build
   $ uv run --extra gui --group gui-build python scripts/build_gui.py

The build output is written beneath ``build/nuitka``. See the repository
README for platform-specific compiler and packaging notes.