Updated packaging notes.

This commit is contained in:
Joe Testa 2024-10-15 18:29:25 -04:00
parent 772204ce8b
commit 84647ecb32

View File

@ -15,10 +15,10 @@ An executable can only be made on a Windows host because the PyInstaller tool (h
# PyPI
To create package and upload to test server (hint: use username '\_\_token\_\_' and API token for test.pypi.org):
To create package and upload to test server (hint: use API token for test.pypi.org):
```
$ sudo apt install python3-virtualenv python3.10-venv
$ sudo apt install python3-virtualenv python3.12-venv
$ make -f Makefile.pypi
$ make -f Makefile.pypi uploadtest
```
@ -26,12 +26,12 @@ To create package and upload to test server (hint: use username '\_\_token\_\_'
To download from test server and verify:
```
$ virtualenv -p /usr/bin/python3 /tmp/pypi_test
$ 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 username '\_\_token\_\_' and API token for production pypi.org):
To upload to production server (hint: use API token for production pypi.org):
```
$ make -f Makefile.pypi uploadprod
@ -40,7 +40,7 @@ To upload to production server (hint: use username '\_\_token\_\_' and API token
To download from production server and verify:
```
$ virtualenv -p /usr/bin/python3 /tmp/pypi_prod
$ virtualenv /tmp/pypi_prod
$ cd /tmp/pypi_prod; source bin/activate
$ pip3 install ssh-audit
```
@ -48,14 +48,14 @@ To download from production server and verify:
# Snap
To create the snap package, run a fully-updated Ubuntu Server 22.04 VM.
To create the Snap package, run a fully-updated Ubuntu Server 24.04 VM.
Create the snap package with:
Create the Snap package with:
```
$ ./build_snap.sh
```
Upload the snap with:
Upload the Snap with:
```
$ snapcraft export-login ~/snap_creds.txt
@ -68,7 +68,7 @@ Upload the snap with:
# Docker
Ensure that the buildx plugin is available by following the installation instructions available at: https://docs.docker.com/engine/install/ubuntu/
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: