gravitybee 0.4.6

Step 1 - Install

You must install the application you wish to build (e.g., yoursuperapp), as well as GravityBee.

$ pip install yoursuperapp gravitybee

The process will also work fine if you’re installing from a local version of your app.

$ cd yoursuperapp
$ ls setup*
setup.cfg            setup.py
$ pip install --editable .
$ pip install gravitybee

Step 2 - Provide (or gather) information

GravityBee will assume all necessary information when run. However, you may wish to override the assumed values. You can provide values either through environment variables or command line flags. If both are provided, command line flags take precedence.

Local logging can be configured in gravitybee/logging.conf.

Options:

If you are using environment variables, you could set them up like this.

$ export GB_APP_NAME=coolapp
$ export GB_PKG_NAME=coolapp
$ export GB_SCRIPT=/usr/var/python/etc/coolapp

Step 3 - Generate

Creating the standalone application is easy now.

$ gravitybee

If you are not using environment variables, you can combine steps 2 and 3.

$ gravitybee --app-name coolapp --script /usr/var/python/etc/coolapp --pkg-dir coolapp

Output Files

If the --no-file flag is not used, GravityBee will create output files. These include:

• gravitybee-files.json: A JSON file that contains information about the standalone application generated by GravityBee including filename, path, mime-type, and label as a list of dicts.

• gravitybee-info.json: A JSON file that contains information extracted about the application including app_name, app_version, console_script, script_path, pkg_dir, src_dir, name_format, clean, work_dir, gen_file, gen_file_w_path, and extra_data.

• gravitybee-environs.sh: A shell file that can be sourced on POSIX platforms to create environment variables with GravityBee information. Each is prefixed with GB_ENV_.

• gravitybee-environs.bat: A batch file that can be used to create environment variables with GravityBee information on Windows. Each environ is prefixed with GB_ENV_.

The Test Example

Here is the file/package structure of the included test application.

gbtestapp
|-- setup.py
|-- setup.cfg
>-- src
|   >-- gbtestapp
|       |-- __init__.py
|       |-- cli.py
|       >-- gbextradata
|           |-- __init__.py
|           |-- data_file.txt

You would build the application as follows. Since the application package is under the src directory, you need to let GravityBee know. Also, since we need to include the data_file.txt file, we’ll use the --extradata option to include the containing directory (gbextradata).

$ cd gbtestapp
$ gravitybee --src-dir src --extra-data gbextradata --clean

From Python Example

Using GravityBee from a Python script is also possible. Using the sample test app, here’s some example code.

import gravitybee

args = gravitybee.Arguments(
    src_dir="src",
    extra_data=["gbextradata"],
    pkg_dir=os.path.join("tests", "gbtestapp"),
    clean=True
)

pg = gravitybee.PackageGenerator(args)
pg.generate()

# show path (and name) of standalone app
print("The standalone app: ", pg.gen_file_w_path)

0.3.0 - 2022.04.21

• [DEPRECATION] Deprecates Python 3.6 support.

0.2.0 - 2021.08.02

• [FEATURE] Add option –hook-template that allows user to specify their own hook template for PyInstaller.

• [FIX] Update the included hook-template to work correctly when the pkg_name and app_name are different.

0.1.29 - 2020.01.15

• [ENHANCEMENT] Remove pipenv files and update setup.cfg dependency versions.

0.1.28 - 2020.01.14

• [ENHANCEMENT] Bump version to include updated dependencies.

0.1.27 - 2019.05.06

• [ENHANCEMENT] Bump version to include updated dependencies.

0.1.26 - 2019.02.05

• [ENHANCEMENT] Fix distutils issue, improve error handling, update versions.

0.1.25 - 2019.01.31

• [ENHANCEMENT] Add distutils to builds.

0.1.24 - 2019.01.29

• [ENHANCEMENT] Clean up code, add community docs.

• [ENHANCEMENT] Transfer to Plus3IT.

0.1.23 - 2019.01.24

• [FIX] Properly pin Pip so all dependencies are installed with pinned Pip version.

• [ENHANCEMENT] Restructure Travis CI linting, testing, deploying so deploy only happens when other stages complete successfully.

• [ENHANCEMENT] Improve speed of MacOS builds significantly.

0.1.22 - 2019.01.22

• [ENHANCEMENT] Pin Pip and Pytest versions, adding requirements.txt.

0.1.21 - 2019.01.10

• [ENHANCEMENT] Lint code to conform with pylint and flake8 and add them Travis-CI tests.

• [ENHANCEMENT] Use pipenv and a lock file for dependency management.

• [ENHANCEMENT] Adjust for compatibility with Python 3.7.

0.1.20 - 2018.08.08

• [ENHANCEMENT] Add --label-format option so that users can customize the label displayed for their applications in gravitybee-files.json.

0.1.19 - 2018.07.11

• [ENHANCEMENT] Add --extra-pkgs and --extra-modules options for including additional packages and modules with standalone executables.

0.1.18 - 2018.07.05

• [ENHANCEMENT] Add --onedir flag for improved debugging.

0.1.17 - 2018.06.27

• [FIX] Compatibility issues with CentOS 6 resolved.

0.1.16 - 2018.06.21

• [FIX] Compatibility issues with Windows resolved.

0.1.15 - 2018.06.06

• [FIX] Losing .exe extension with Windows executables in the latest staging area.

0.1.14 - 2018.06.04

• [FIX] --with-latest was not working as a CL flag.

0.1.13 - 2018.06.04

• [ENHANCEMENT] Rearrange files created by GravityBee to all be contained in a .gravitybee subdirectory of the current directory.

• [ENHANCEMENT] Place the distribution artifacts in the staging directory, with a default value of .gravitybee/dist.

• [ENHANCEMENT] Add option --staging-dir to specify directory where artifact staging should take place and export another environment variable GB_ENV_STAGING_DIR.

• [ENHANCEMENT] Add option --with-latest to allow creation of a second artifact staging directory called “latest” containing the artifacts renamed with “latest” in the place of the version.

• [ENHANCEMENT] Add option --sha-format to allow custom naming of the SHA hash file.

0.1.12 - 2018.05.29

• [ENHANCEMENT] Add OS and machine type to the SHA256 hash file (to avoid overwriting files if files from different platforms go to the same location).

• [ENHANCEMENT] Cleanup code with better variable names.

0.1.11 - 2018.05.24

• [ENHANCEMENT] Create a SHA256 hash for the generated standalone file and include hash with file information and optionally in a separate file (using –sha flag).

• [ENHANCEMENT] Change names of environment variables produced with output scripts to be prefixed with GB_ENV so that the environs do not collide with environs consumed by GravityBee.

• [ENHANCEMENT] Provide a convenience cleanup Bash script to remove GravityBee output files (e.g., json and generated executables).

• [ENHANCEMENT] Cleanup code with more constants.

0.1.10 - 2018.05.21

• [ENHANCEMENT] Provide two additional output files for importing GravityBee information into the environment on POSIX and Windows platforms.

0.1.9 - 2018.05.14

• [ENHANCEMENT] Output file with run info in json format for easy consumption by other tools.

0.1.8 - 2018.05.11

• [ENHANCEMENT] In non-verbose mode, allow for supressing stdout and stderr from pyinstaller, which can be sizeable.

• [ENHANCEMENT] Change name of gravitybee.file to gravitybee-files.json.

0.1.7 - 2018.05.11

• [FIX] Fix exit code (was returning True).

• [ENHANCEMENT] Automatically find console script installed by setuptools on Windows and Linux and variety of places.

0.1.6 - 2018.05.03

• [ENHANCEMENT] Follow format prescribed by satsuki for output file (potential for multiple files).

0.1.5 - 2018.05.01

• [ENHANCEMENT] Add mime-type and label to .json formatted file information stored in gravitybee.file.

0.1.3 - 2018.05.01

• [ENHANCEMENT] Create gravitybee.file with name of standalone application.

0.1.2 - 2018.04.27

• [ENHANCEMENT] Provide standalone file and path.

• [FIX] Path bug.

0.1.1 - 2018.04.26

• [FIX] Many bug fixes.

0.1.0 - 2018.04.20

• Initial release!