ssh-audit/PACKAGING.md

# Windows

An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.

1.) Install Python v3.x from https://www.python.org/.  To make life easier, check the option to add Python to the PATH environment variable.

2.) Install Cygwin (https://www.cygwin.com/).

3.) Install/update package dependencies and create the executable with:

```
    $ ./build_windows_executable.sh
```


# PyPI

To create package and upload to test server (hint: use API token for test.pypi.org):

```
    $ sudo apt install python3-virtualenv python3.12-venv
    $ make -f Makefile.pypi
    $ make -f Makefile.pypi uploadtest
```

To download from test server and verify:

```
    $ virtualenv /tmp/pypi_test
    $ cd /tmp/pypi_test; source bin/activate
    $ pip3 install --index-url https://test.pypi.org/simple ssh-audit
```

To upload to production server (hint: use API token for production pypi.org):

```
    $ make -f Makefile.pypi uploadprod
```

To download from production server and verify:

```
    $ virtualenv /tmp/pypi_prod
    $ cd /tmp/pypi_prod; source bin/activate
    $ pip3 install ssh-audit
```


# Snap

To create the Snap package, run a fully-updated Ubuntu Server 24.04 VM.

Create the Snap package with:
```
    $ ./build_snap.sh
```

Upload the Snap with:

```
    $ snapcraft export-login ~/snap_creds.txt
    $ export SNAPCRAFT_STORE_CREDENTIALS=$(cat ~/snap_creds.txt)
    $ snapcraft upload --release=beta ssh-audit_*.snap
    $ snapcraft status ssh-audit  # Note the revision number of the beta channel.
    $ snapcraft release ssh-audit X stable  # Fill in with the revision number.
```


# Docker

Ensure that the `buildx` plugin is available by following the installation instructions available at: https://docs.docker.com/engine/install/ubuntu/

Build a local image with:

```
    $ make -f Makefile.docker
```

Create a multi-architecture build and upload it to Dockerhub with (hint: use the API token as the password):

```
    $ make -f Makefile.docker upload
```