File: dev.rst

package info (click to toggle)
python-briefcase 0.3.25-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,596 kB
  • sloc: python: 62,519; makefile: 60
file content (71 lines) | stat: -rw-r--r-- 1,804 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
===
dev
===

Run the application in developer mode.

Usage
=====

To run your application in development mode on the current platform's default output format:

.. code-block:: console

    $ briefcase dev

To run your application for a different platform:

.. code-block:: console

    $ briefcase dev <platform>

To run your application using a specific output format:

.. code-block:: console

    $ briefcase dev <platform> <output format>

The first time the application runs in developer mode, any requirements listed in a
:attr:`requires` configuration item in ``pyproject.toml`` will be installed into the
current environment.

Options
=======

The following options can be provided at the command line.

``-a <app name>`` / ``--app <app name>``
----------------------------------------

Run a specific application target in your project. This argument is only
required if your project contains more than one application target. The app
name specified should be the machine-readable package name for the app.

``-r`` / ``--update-requirements``
----------------------------------

Update application requirements.

``--no-run``
------------
Do not run the application; only install application requirements.

``--test``
----------

Run the test suite in the development environment.

Passthrough arguments
---------------------

If you want to pass any arguments to your app's command line, you can specify them
using the ``--`` marker to separate Briefcase's arguments from your app's arguments.
For example:

.. code-block:: console

    $ briefcase dev -- --wiggle --test

will run the app in normal mode, passing the ``--wiggle`` and ``--test`` flags to
the app's command line. The app will *not* run in *Briefcase's* test mode; the
``--test`` flag will be left for your own app to interpret.