Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srevinsaju/pyappimage
AppImage builder, just for python.
https://github.com/srevinsaju/pyappimage
appimage appimage-builder appimages binary hacktoberfest packaging packaging-python python python3
Last synced: 2 months ago
JSON representation
AppImage builder, just for python.
- Host: GitHub
- URL: https://github.com/srevinsaju/pyappimage
- Owner: srevinsaju
- License: mit
- Created: 2020-08-20T17:12:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-08T07:57:41.000Z (about 3 years ago)
- Last Synced: 2024-04-13T21:12:50.523Z (8 months ago)
- Topics: appimage, appimage-builder, appimages, binary, hacktoberfest, packaging, packaging-python, python, python3
- Language: Python
- Homepage:
- Size: 120 KB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-appimage - PyAppImage - Ultimately simple python-to-appimage bundler. (AppImage developer tools / Deployment tools for Python applications)
README
PyAppImage :snake:
Create optimized Python AppImages, faster!
[](https://www.python.org/)
    [](https://webchat.freenode.net/?channels=AppImage)
[](https://github.com/AppImage/awesome-appimage)
 
## Getting Started
> The project is still in beta. Consider reporting bugs to help development and release a stable version;
### Download `pyappimage`
* Choose the Python Version. Currently, the supported Python versions are `3.6`, `3.7` and `3.8`.
These AppImages are built using [python-appimage](https://github.com/niess/python-appimage) which
includes the Python Interpreter. See [why not `pyappimage`](#why-not-pyappimage) section for more
details. Corresponding to the python version, binaries will be built, using [PyInstaller]
(https://github.com/PyInstaller/PyInstaller) and are processed to make the necessary changes.
* Get the latest `pyappimage.AppImage` to begin development
### PyAppImage tutorial
Here are some small tutorials to package some applications, and to workaround bugs when packaging software
1. Hello World AppImage
2. [Packaging Archivy](guides/archivy.md)
3. [Packaging AppImageLint](guides/appimagelint.md)
### Configuration parameters
`pyappimage` can be configured using the following parameters
#### `entrypoint`
Entrypoint is a path to the function. It is normally in the format
```python
folder.script:function
```
here, the function located in `script` file, of which the script file is
located in the `folder` called `folder` is executed.
#### Environment Variables
Environment variables can be set before the appimage entrypoint is called.
This can be useful in defining AppImage based variables or conditionally executing some functions when the app is being run within an appimage,
```yml
environment:
HELLO: TEST
```
This will be translated to
```bash
export HELLO=TEST
```
#### Include additional data to AppImage
These are `data` objects, including items like `png`, `json`, `txt` items which you would like to place in the AppImage. Just simple add
```
data:
$CWD/somefile/photo.png: $APPIMAGE/photo.png
/usr/share/icons/myphoto.svg: $APPIMAGE/icons/icon.png
```
#### Custom Icon
Place `.png` in the `pyappimage` directory, and it will be automatically set as the AppImage dir icon.
#### Custom Desktop File
`pyappimage` automatically generates the desktop file for you. If you want to override the desktop file generated by `pyappimage`, you can add a `.desktop` desktop file in the `pyappimage` directory, and that will be added. Make sure that your desktop file matches FreeDesktop's standards.
## When to use `pyappimage` ?
### Use `pyappimage` when
* You are creating a command line application
* Your application has reached `beta` stage
* If you have intermediate coding skills on Python
* You are writing an Hello World Application which does not need the entire Python interpreter
* If you are worried about the huge python appimage
* If you are highly experienced with PyInstaller or nuitka
### Do not use `pyappimage` when
* If your project is still in alpha
* If your project requirements are not properly written
* If you do not have a `setup.py`
* If you are building a Qt Application? (needs more references. `PyQt` pyappimage weighed 119 MB on `guiscrcpy`, so the difference is very tiney)
## Similar projects
[Awesome AppImage Python development tools](https://github.com/AppImage/awesome-appimage#deployment-tools-for-python-applications) provide a list of Awesome
tools to speed up distributing your python apps. Do check them out.
`pyappimage-*.AppImage` which you use to build your optimized Python AppImages itself use @niess 's [python-appimage](https://github.com/niess/python-appimage).
Because `pyappimage` needs a real python interpreter to bundle Python appimages for you!
## License
```
MIT License
Copyright (c) 2020 Srevin Saju
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Copyright
(c) Srevin Saju 2020
PyAppImage logo is a remix of the [Papirus Icon Theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme).