Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Tools to support converting a Python project into a standalone native application.

Project Description

http://pybee.org/briefcase/static/images/briefcase-72.png

Briefcase

Tools to support converting a Python project into a standalone native application.

Quickstart

In your virtualenv, install Briefcase:

$ pip install briefcase

Then, add extra options to your setup.py file to provide the app-specific properties of your app. Settings that are applicable to any app can be set under the app key; platform specific settings can be specified using a platform key:

setup(
    ...
    options={
        'app': {
            'formal_name': 'My First App',
            'bundle': 'org.example',
            'icon': 'icons/app.icns',
        },
        'osx': {
            'app_requires': [
                'toga[osx]'
            ]
        },
        'ios': {
            'app_requires': [
                'toga[ios]'
            ],
            'icon': {
                '29': 'icons/app-29.png',
                '40': 'icons/app-40.png',
                '58': 'icons/app-58.png',
                '76': 'icons/app-76.png',
                '80': 'icons/app-80.png',
                '87': 'icons/app-87.png',
                '120': 'icons/app-120.png',
                '152': 'icons/app-152.png',
                '167': 'icons/app-167.png',
                '180': 'icons/app-180.png',
            },
            'splash': {
                '1024x768': 'splash/splash-1024x768.png',
                '1536x2048': 'splash/splash-1536x2048.png',
                '2048x1536': 'splash/splash-2048x1536.png',
                '768x1024': 'splash/splash-768x1024.png',
                '640x1136': 'splash/splash-640x1136.png',
                '640x960': 'splash/splash-640x960.png',
            }
        },
        'android': {
            'app_requires': [
                'toga[android]'
            ]
        },
    }
)

At a minimum, you must set a formal_name key (the full, formal name for the app) and a bundle key (the bundle identifier for the author organization - usually a reverse domain name).

Then, you can invoke briefcase, using:

$ python setup.py osx

to create an OS/X app, or:

$ python setup.py ios

to create an iOS app, or:

$ python setup.py android

to create an Android app.

Community

Briefcase is part of the BeeWare suite. You can talk to the community through:

Contributing

If you experience problems with Briefcase, log them on GitHub. If you want to contribute code, please fork the code and submit a pull request.

Release history Release notifications

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

This version
History Node

0.1.1

History Node

0.1.0

History Node

0.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
briefcase-0.1.1-py2.py3-none-any.whl (10.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Dec 21, 2015
briefcase-0.1.1.tar.gz (14.1 kB) Copy SHA256 hash SHA256 Source None Dec 21, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page