Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUILDING] Add doc. and CI steps for standalone building with Nuitka #136

Merged
merged 1 commit into from
Aug 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion .github/workflows/integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ jobs:

- name: Install required dependencies for standalone builds
run: |
sudo apt update && sudo apt install -y patchelf
python -m pip install --upgrade pip setuptools
pip install pex stickytape pyinstaller
pip install nuitka pex stickytape pyinstaller

- name: Install module regularly
run: pip install .
Expand All @@ -50,6 +51,21 @@ jobs:
- name: Run our test suite
run: python -m unittest

# Disabled against PyPy.
# Currently disabled against Python 3.12.
- name: Standalone building (with Nuitka)
if: ${{ matrix.python-version != 'pypy3.9' && matrix.python-version != '3.12-dev' }}
run: |
python -m nuitka \
--onefile \
--include-package=archey.logos \
--output-filename=archey \
--output-dir=dist \
--quiet \
archey/__main__.py
time ./dist/archey
rm dist/archey

# Currently disabled against Python 3.12.
- name: Standalone building (with PEX)
if: ${{ matrix.python-version != '3.12-dev' }}
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,17 @@ install -D -m0644 config.json ~/.config/archey4/config.json
> Some procedures below walk you through several ways of building Archey as a standalone program.

```bash
# Using Nuitka (recommended) :
apt install -y patchelf
pip3 install nuitka
python3 -m nuitka \
--onefile \
--include-package=archey.logos \
--output-filename=archey \
--output-dir=dist \
--quiet \
archey/__main__.py

# Using PEX (recommended) :
pip3 install pex
pex \
Expand Down