BentoDev - BentoBox Local Theme Editor

1   Main Features

• Edit BentoBox themes locally
• Uses real data when making themes
• Use Flask to act as a proxy between server requests
• Uses Jinja2 to rigidly enforce template edits

2   Installation

NOTE: This package is currently only supported on POSIX systems. For those on Windows it is recommended to create a new Vagrant box before installing.

It is recommended to install bentodev on a seperate Python 3 virtual environment:

$ virtualenv -p python3 venv
$ source venv/bin/activate

After ensuring one is on the correct Python 3 environment simply pip install the latest version:

$ pip install bentodev

3   Usage

BentoDev functions are activated via a command line interface.

$ bentodev
Usage: bentodev [OPTIONS] COMMAND [ARGS]...

BentoDev Used to develop themes locally for BentoBox sites!

Options:
--version  Show the version and exit.
--help     Show this message and exit.

Commands:
  clone   Clone an account you have access too.
  config  Base configuration
  list    List accounts and themes you have access too.
  start   Begin running the development server

3.1   Setup

Upon using BentoDev for the first time you will be propmted to use add your BentoBox account.

You may also be asked for a password to get a remote token for your session.

3.2   Cloning Themes

By using the command bentodev list or bentodev start you will see the list of available Accounts and their current associated theme.

If you do not see any Accounts/Themes you need to create an Account that is associated to your User through the BentoBox website.

To work on an Account's theme you must first clone the theme. To do so use:

$ bentodev clone <theme_name>

You may be prompted to connect your GitHub account to BentoBox if you have not done so previously.

The theme will then be cloned to the ~/bentodev/sites/<theme_name> folder, where you can then push edits with standard git commands.

3.3   Working on Themes

Once a theme has been cloned you can then run a small local server that will handle making requests to BentoBox.

$ bentodev start <account_name>

You should then see the server run, where you can connect at localhost:5000

4   Development

To develop simply Git clone the associated URL.

Feature or test branches created must have be approved through pull request review before merging with master.

To make use of all debugging features, run the BentoBox Django application locally and then run the bentodev server with the flag --local:

$ bentodev start <account_name> --local

5   User Configuration

Additional user settings can be added to the user config file at ~/bentodev/config.json. Default settings include:

{
  "BENTO_USER": "<user_name>"
}

Addtional settings can be added by hand. These include

{
  "DEV_ROOT": "<dir_pat>", (ie. "/Users/<user>/test_folder/")
  "HOST": "<host_value>", (ie. "0.0.0.0")
  "PORT": "<port_value>", (i.e "8000")
}

6   Meta

6.1   User support

Please use the following support channels:

• GitHub issues for bug reports and feature requests.
• StackOverflow to ask questions (please make sure to use the bentodev tag).
• Tweet directly to @bentoboxnyc.
• You can also tweet directly to `@djstein`_.

6.2   Related projects

6.2.1   BentoBox

The entire utility is completely coupled to the BentoBox Django Application.

It pulls data from the production (or a local) BentoBox instance and allows real data to displayed as engineers/designers edit themes that are displayed on the getbento.com domain.

6.2.2   Dependencies

• Flask
• Jinja2
• Requests