File: README.md

package info (click to toggle)
python-briefcase 0.3.25-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,596 kB
  • sloc: python: 62,519; makefile: 60
file content (75 lines) | stat: -rw-r--r-- 2,867 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
[<img src="https://beeware.org/project/briefcase/briefcase.png" width="72" alt="logo" />](https://beeware.org/briefcase)

# Briefcase

[![Python Versions](https://img.shields.io/pypi/pyversions/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
[![PyPI Version](https://img.shields.io/pypi/v/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
[![Maturity](https://img.shields.io/pypi/status/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
[![BSD License](https://img.shields.io/pypi/l/briefcase.svg)](https://github.com/beeware/briefcase/blob/main/LICENSE)
[![Build Status](https://github.com/beeware/briefcase/workflows/CI/badge.svg?branch=main)](https://github.com/beeware/briefcase/actions)
[![Discord server](https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic)](https://beeware.org/bee/chat/)

Briefcase is a tool for converting a Python project into a standalone
native application. You can package projects for:

- Mac
- Windows
- Linux
- iPhone/iPad
- Android
- Web

Support for AppleTV, watchOS, and wearOS deployments is planned.

## Getting started

To install Briefcase, run:

    $ python -m pip install briefcase

If you would like a full introduction to using Briefcase, try the
[BeeWare tutorial](https://docs.beeware.org). This tutorial walks you
through the process of creating and packaging a new application with
Briefcase.

## Financial support

The BeeWare project would not be possible without the generous support
of our financial members:

[![Anaconda logo](https://beeware.org/community/members/anaconda/anaconda-large.png)](https://anaconda.com/)

Anaconda Inc. - Advancing AI through open source.

Plus individual contributions from [users like
you](https://beeware.org/community/members/). If you find Briefcase, or
other BeeWare tools useful, please consider becoming a financial member.

## Documentation

Documentation for Briefcase can be found on [Read The
Docs](https://briefcase.readthedocs.io).

## Community

Briefcase is part of the [BeeWare suite](https://beeware.org). You can
talk to the community through:

- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware)
- [Discord](https://beeware.org/bee/chat/)
- The Briefcase [GitHub Discussions
  forum](https://github.com/beeware/briefcase/discussions)

We foster a welcoming and respectful community as described in our
[BeeWare Community Code of
Conduct](https://beeware.org/community/behavior/).

## Contributing

If you experience problems with Briefcase, [log them on
GitHub](https://github.com/beeware/briefcase/issues).

If you'd like to contribute to Briefcase development, our [contribution
guide](https://briefcase.readthedocs.io/en/latest/how-to/contribute/index.html)
details how to set up a development environment, and other requirements
we have as part of our contribution process.