Daily AppImage build & update README

This commit is contained in:
Valentin Niess
2020-04-07 23:26:23 +02:00
parent eac9a7ae91
commit 817c293c2a
2 changed files with 34 additions and 8 deletions

View File

@@ -4,6 +4,8 @@ on:
paths:
- '.github/workflows/appimage.yml'
- 'python_appimage/**'
schedule:
- cron: '0 3 * * *'
jobs:
Build:

View File

@@ -4,8 +4,14 @@ _Ready to use AppImages of Python are available as GitHub [releases][RELEASES]._
## Quickstart
Our AppImages provide relocatable Python runtimes. Installation is as simple as
downloading a single file and changing its mode to executable, e.g. as:
We provide relocatable Python runtimes as [AppImages][APPIMAGE]. These runtimes
are extracted from [manylinux][MANYLINUX] Docker images. The corresponding
images are available as GitHub [releases][RELEASES]. They are labeled according
to [wheels][WHEEL] compatibility tags. Our Python AppImages are updated
daily.
Running Python from these [AppImages][APPIMAGE] is as simple as downloading a
single file and changing its mode to executable, e.g. as:
```sh
wget https://github.com/niess/python-appimage/releases/download/\
@@ -15,13 +21,13 @@ chmod +x python3.8.2-cp38-cp38-manylinux1_x86_64.AppImage
./python3.8.2-cp38-cp38-manylinux1_x86_64.AppImage
```
This should run Python 3.8 on _almost_ any Linux provided that `fuse` is
available. Note that on WSL1 since `fuse` is not supported you will need to
extract the AppImage as explained hereafter.
This should start a Python 3.8 interactive session on _almost_ any Linux
provided that `fuse` is available. Note that on WSL1 since `fuse` is not
supported you will need to extract the AppImage as explained hereafter.
The installation mode described previously is enough if you only need vanilla
Python with its standard library. However, if you plan to install extra
packages we recommmed extracting the AppImage, e.g. as:
The workflow described previously is enough if you only need vanilla Python with
its standard library. However, if you plan to install extra packages we
recommend extracting the AppImage, e.g. as:
```sh
./python3.8.2-cp38-cp38-manylinux1_x86_64.AppImage --appimage-extract
@@ -38,5 +44,23 @@ example upgrading pip can be done as:
pip install --upgrade pip
```
## For applications developers
Python [AppImages][APPIMAGE] are built using the `python_appimage` Python
package. You can get it from [GitHub][GITHUB] or [PyPI][PYPI]. Examples of usage
can be found by browsing GitHub [workflows][WORKFLOWS].
The `python_appimage` package also allows to build basic Python apps from an
existing Python AppImage and a recipe folder. The recipe folder contains the
app metadata, a Python requirements file and an entry point script. Examples of
recipes can be found on GitHub in the [applications][APPLICATIONS] folder.
[APPIMAGE]: https://appimage.org
[APPLICATIONS]: https://github.com/niess/python-appimage/tree/master/applications
[GITHUB]: https://github.com/niess/python-appimage
[MANYLINUX]: https://github.com/pypa/manylinux
[PYPI]: https://pypi.org/project/python-appimage
[RELEASES]: https://github.com/niess/python-appimage/releases
[WHEEL]: https://pythonwheels.com
[WORKFLOWS]: https://github.com/niess/python-appimage/tree/master/.github/workflows