Make runnable desktop apps from your python scripts more easily with pyvan!
Project description
Make runnable desktop/cmd apps from your python scripts!
Install
pip install pyvan
or download pyvan.py file.
Usage
Make a "van.py" file next to the "main.py" file (entry point of your program)
Paste the code bellow:
import pyvan
OPTIONS = {
"main_file_name": "main.py",
"show_console": False,
"use_existing_requirements": True,
"extra_pip_install_args": [],
"use_pipreqs": False,
"install_only_these_modules": [],
"exclude_modules": [],
"include_modules": [],
"path_to_get_pip_and_python_embedded_zip": "",
"build_dir": "dist",
"pydist_sub_dir": "pydist",
"source_sub_dir": "",
}
pyvan.build(**OPTIONS)
Configurations
Option | Default | Description |
---|---|---|
main_file_name | required | the entry point of the application |
show_console | True | show console window or not (for a service or GUI app) |
use_existing_requirements | True | if True pyvan will use an existing requirements.txt file instead of generating one using the: `use_pipreqs |
extra_pip_install_args | [] | pyvan will append the provided arguments to the pip install command during installation of the stand-alone distribution.The arguments should be specified as a list of strings |
use_pipreqs | True | pipreqs tries to minimize the size of your app by looking at your imports (best way is to use a virtualenv to ensure a smaller size |
install_only_these_modules | [] | pyvan will install only the modules mentioned here |
exclude_modules | [] | modules to exclude from bundle |
include_modules | [] | modules to include in the bundle |
path_to_get_pip_and_python_embedded_zip | '' | by default is the Download path (path to 'get-pip.py' and 'python-x.x.x-embed-amdxx.zip' files) |
build_dir | dist | the directory in which pyvan will create the stand-alone distribution |
pydist_sub_dir | pydist | a sub directory relative to build\_dir where the stand-alone python distribution will be installed |
source_sub_dir | '' | a sub directory relative to build\_dir where the to execute python files will be installed |
input_dir | '.' | the directory to get the main_file_name file from |
icon_location | TODO | for now pyvan will create a .bat file which links the main_file_name with python.exe in the future will add something that will convert the .bat to .exe and you will be able to set it an icon too |
If pyvan didn't managed to install all the modules needed go in dist/Scripts folder and install them manually with pip install module
For creating a .exe with a custom icon checkout bellow repos:
- https://github.com/tokyoneon/B2E
- https://github.com/tywali/Bat2ExeConverter
- https://github.com/DarrenRainey/battoexe
- https://github.com/julianollivieira/b2executable
Why pyvan?
pyvan it's just one file which takes the embedded python version, installs the modules you need and makes a link using a .bat file between python(w).exe and your main.py script.
It's easy if something goes wrong for whatever reason you can just go in the dist folder and solve the issue the python way (because there is just python and your scripts :).
Submit any questions/issues you have! Fell free to fork it and improve it!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.