Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
framework: [ "toga", "pyside6", "pygame", "console" ]
# Pygame hasn't published 3.14 wheels yet.
python-version: [ "3.11", "3.12", "3.13", "3.14", "3.15" ]
framework: [ "toga", "pyside6", "console" ]
exclude:
- python-version: "3.14"
framework: pygame
# PySide6 hasn't published 3.15 wheels yet.
- python-version: "3.15"
framework: pyside6
7 changes: 7 additions & 0 deletions .github/workflows/update-binary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@ jobs:
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
fetch-depth: 0
fetch-tags: true

- name: Get build artifacts
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
.python-version
.vscode
.idea
.rumdl_cache
stub/build
stub/logs
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ repos:
- id: check-case-conflict
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/rvben/rumdl-pre-commit
rev: v0.2.60
hooks:
- id: rumdl
- id: rumdl-fmt
- repo: https://github.com/zizmorcore/zizmor-pre-commit
rev: v1.25.2
hooks:
Expand Down
8 changes: 2 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

BeeWare <3's contributions!

Please be aware that BeeWare operates under a [Code of
Conduct](https://beeware.org/community/behavior/code-of-conduct/).
Please be aware that BeeWare operates under a [Code of Conduct](https://beeware.org/community/behavior/code-of-conduct/).

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.
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.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ However, if you *do* want use this template directly...

1. Install [cookiecutter](https://github.com/cookiecutter/cookiecutter). This is a tool used to bootstrap complex project templates:

```text
```console
pip install cookiecutter
```

2. Run `cookiecutter` on the template:

```text
```console
cookiecutter https://github.com/beeware/briefcase-macOS-Xcode-template
```

This will ask you for a number of details of your application, including the `name` of your application (which should be a valid PyPI identifier), and the `Formal Name` of your application (the full name you use to describe your app). The remainder of these instructions will assume a `name` of `my-project`, and a formal name of `My Project`.
This will ask you for a number of details of your application, including the name of your application (which should be a valid PyPI identifier), and the formal name of your application (the full name you use to describe your app). The remainder of these instructions will assume a name of `my-project`, and a formal name of `My Project`.

3. [Obtain a Python Apple support package for macOS](https://github.com/beeware/Python-Apple-support), and extract it into the `Xcode/Support` directory generated by the template.

4. Add your code to the template, into the `Xcode/My Project/app`. directory. At the very minimum, you need to have an `app/<app name>/__main__.py` file that will be run on startup.

If your code has any dependencies, they should be installed into the `Xcode/My Project/app_packages` directory.
If your code has any dependencies, they should be installed into the `Xcode/My Project/app_packages` directory.

If you've done this correctly, a project with a formal name of `My Project`, with an app name of `my-project` should have a directory structure that looks something like:

Expand Down Expand Up @@ -58,4 +58,4 @@ To do something interesting, you'll need to work with the native macOS system li

Regardless of whether you use Toga, or you write an application natively, the template project will try to start a Python module matching the name of the `MainModule` property in the `Info.plist` file associated with the project. If that module can't be started, any error raised will be logged, and the Python interpreter will be shut down. All console output and errors are automatically redirected to the macOS system console.

If you have any external library dependencies (like Toga, or anything other third-party library), you should install the library code into the `app_packages` directory. This directory is the same as a `site_packages` directory on a desktop Python install.
If you have any external library dependencies (like Toga, or anything other third-party library), you should install the library code into the `app_packages` directory. This directory is the same as a `site_packages` directory on a desktop Python install.
29 changes: 29 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[tool.rumdl]
flavor = "mkdocs"
include = ["**/*.md"]
exclude = ["comment.md", "CODE_OF_CONDUCT.md"]
respect-gitignore = true
force-exclude = true

# Disable rules:
# MD014: Forces commands in codeblocks to show output
# MD042: Empty link - buggy, still flagging on valid MkDocs formatting
# MD052: Reference link not found - buggy, flagging on valis MkDocs links
disable = ["MD014", "MD042", "MD052"]

[tool.rumdl.MD007]
indent = 4

[tool.rumdl.MD013] # Line length
line_length = 999999 # Force reflow to paragraph content to remove linebreaks
reflow = true
reflow_mode = "normalize"

[tool.rumdl.MD026] # Remove punctuation at the end of headings
punctuation = ",;:"

[tool.rumdl.MD033] # No inline HTML
allowed_elements = ["nospell",] # pyspelling inline disable tag

[tool.rumdl.MD046]
style = "fenced"
10 changes: 5 additions & 5 deletions {{ cookiecutter.format }}/briefcase.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ entitlements_path = "{{ cookiecutter.class_name }}/{{ cookiecutter.app_name }}.e

support_path = "Support"
{{ {
"3.10": "support_revision = 14",
"3.11": "support_revision = 9",
"3.12": "support_revision = 9",
"3.13": "support_revision = 14",
"3.14": "support_revision = 10",
"3.11": "support_revision = 10",
"3.12": "support_revision = 10",
"3.13": "support_revision = 15",
"3.14": "support_revision = 11",
"3.15": "support_revision = 0",
}.get(cookiecutter.python_version|py_tag, "") }}
cleanup_paths = [
"Support/Python.xcframework/**/python*/config-*-darwin",
Expand Down