PSProject

Tool to create PySwiftKit based Apps

Installation

Homebrew (Recommended)

First, add the Homebrew tap:

brew tap PythonSwiftLink/tools

Then install PSProject:

brew install psproject

To upgrade PSProject:

brew update
brew upgrade --formula psproject

From Source

Alternatively, you can build PSProject from source using Swift Package Manager.

git clone https://github.com/Py-Swift/PSProject
cd psproject
swift build -c release --disable-sandbox --product PSProject

intel

.build/x86_64-apple-macosx/release/PSProject

arm64

.build/arm64-apple-macosx/release/PSProject

Usage

Create a New Project

First, create a new project which will generate a pyproject.toml file:

psproject init HelloWorld

Navigate to the new project directory:

cd HelloWorld

Or open it in VS Code:

code HelloWorld

Configure for Kivy

The generated pyproject.toml will contain default configuration. To create a Kivy-based app, add Kivy to the project dependencies and configure the PSProject backends:

[project]
name = "helloworld"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
    "kivy"
]

[tool.psproject]
app_name = "HelloWorld"
backends = [
    "kivyschool.kivylauncher"
]
cythonized = false
extra_index = []
pip_install_app = false

[tool.psproject.ios]
backends = []
extra_index = [
    "https://pypi.anaconda.org/beeware/simple",
    "https://pypi.anaconda.org/pyswift/simple",
    "https://pypi.anaconda.org/kivyschool/simple"
]

Create Xcode Project

Generate the Xcode project:

psproject create xcode

Update Site Packages

To update the Xcode project's site-packages:

psproject update site-packages

Additional Resources

• PySwiftKit Wiki
• Setup Guide
• Kivy Project Documentation
• PyProject Configuration
• Kivy on iOS Guide

License

MIT License - See LICENSE file for details