https://github.com/AppImageCrafters/appimage-builder
GNU/Linux packaging solution using the AppImage format
https://github.com/AppImageCrafters/appimage-builder
appimage appimage-builder creation linux packaging tool
Last synced: 21 days ago
JSON representation
GNU/Linux packaging solution using the AppImage format
- Host: GitHub
- URL: https://github.com/AppImageCrafters/appimage-builder
- Owner: AppImageCrafters
- License: mit
- Created: 2019-10-31T19:44:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T03:44:15.000Z (about 1 year ago)
- Last Synced: 2024-04-26T09:32:56.482Z (12 months ago)
- Topics: appimage, appimage-builder, creation, linux, packaging, tool
- Language: Python
- Homepage:
- Size: 1.45 MB
- Stars: 288
- Watchers: 10
- Forks: 52
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-appimage - appimage-builder - Recipe based AppImage creation tool working from source. (AppImage developer tools / Build systems)
README
# appimage-builder
*GNU/Linux packaging made easy!* ™
## What is it?
It's a tool for packing applications along with all of its dependencies using the system package manager to obtain binaries and resolve dependencies. It creates a **self-sufficient** and **portable** bundle using the [AppImage](https://appimage.org) format.
Features:
- Real GNU/Linux packaging. (no more distro packaging)
- Simple recipes.
- Simple workflow.
- Backward and forward compatibility.
- One binary, many target systems.
## Useful links
- [Installation](https://appimage-builder.readthedocs.io/en/latest/intro/install.html)
- [Getting help](https://appimage-builder.readthedocs.io/en/latest/index.html#getting-help)
- [Tutorial](https://appimage-builder.readthedocs.io/en/latest/intro/tutorial.html)
- [Documentation](https://appimage-builder.readthedocs.io)
## Projects using appimage-builder
[](https://github.com/zealdocs/zeal/)
[](https://invent.kde.org/education/kstars)
[](https://localsend.org/#/)
[](https://github.com/swl-x/MystiQ)
[](https://invent.kde.org/maui)
[](https://github.com/adil192/saber)
[](https://davidotek.github.io/protonup-qt/#home)
[
](https://docs.butterfly.linwood.dev/)
## Developers
If you want to contribute, you can install this project from source like this:
(After cloning the repository)
### Requirements
This project requires python 3.8 to work!
### 1. Using pipenv
you can use [pipenv](https://pipenv.pypa.io/) (installed through pip) to simplify the process of setting up a virtual environment.
1. Create a virtual environment:
```shell
pipenv shell
```
if you do not have python 3.8 installed you can use another version like so:
```shell
pipenv shell --python path/to/python
```
2. Install the dependencies:
```shell
pipenv install
```
3. Add the current directory to the list of python modules:
```shell
export PYTHONPATH="`pwd`"
```
At this point you should be able to run appimage-builder by running `pipenv run appimagebuilder`!
### 2. Manual Installation
For those who don't want to use `pipenv` there's a `requirements.txt` file that contains all the dependencies.
Next you need to add the current directory to the list of python modules:
```shell
export PYTHONPATH="`pwd`"
```
Then you can run the project like so:
```shell
python appimagebuilder/__main__.py
```
### Notes
- This project uses the [Black](https://pypi.org/project/black/) code formatter.