{"id":18838600,"url":"https://github.com/beeware/briefcase-ios-xcode-template","last_synced_at":"2025-04-14T06:23:43.742Z","repository":{"id":40360774,"uuid":"224566835","full_name":"beeware/briefcase-iOS-Xcode-template","owner":"beeware","description":"A template for generating iOS Xcode projects with Briefcase","archived":false,"fork":false,"pushed_at":"2025-03-25T00:55:06.000Z","size":3380,"stargazers_count":26,"open_issues_count":0,"forks_count":14,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-27T20:11:47.711Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beeware.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["freakboy3742"],"custom":["http://beeware.org/bee/join"]}},"created_at":"2019-11-28T04:01:02.000Z","updated_at":"2025-03-25T00:55:10.000Z","dependencies_parsed_at":"2023-10-24T23:26:56.909Z","dependency_job_id":"bf901e73-daf4-4db3-800c-73351539e089","html_url":"https://github.com/beeware/briefcase-iOS-Xcode-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-iOS-Xcode-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-iOS-Xcode-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-iOS-Xcode-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbriefcase-iOS-Xcode-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/briefcase-iOS-Xcode-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248831326,"owners_count":21168447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T02:39:59.689Z","updated_at":"2025-04-14T06:23:43.707Z","avatar_url":"https://github.com/beeware.png","language":"Objective-C","funding_links":["https://github.com/sponsors/freakboy3742","http://beeware.org/bee/join"],"categories":[],"sub_categories":[],"readme":"Briefcase iOS Xcode Template\n============================\n\nA `Cookiecutter \u003chttps://github.com/cookiecutter/cookiecutter/\u003e`__ template for\nbuilding Python apps that will run under iOS.\n\nUsing this template\n-------------------\n\nThe easiest way to use this project is to not use it at all - at least, not\ndirectly. `Briefcase \u003chttps://github.com/beeware/briefcase/\u003e`__ is a tool that\nuses this template, rolling it out using data extracted from a\n``pyproject.toml`` configuration file.\n\nHowever, if you *do* want use this template directly...\n\n1. Install `cookiecutter`_. This is a tool used to bootstrap complex project\n   templates::\n\n    $ pip install cookiecutter\n\n2. Run ``cookiecutter`` on the template::\n\n    $ cookiecutter https://github.com/beeware/briefcase-iOS-Xcode-template\n\n   This will ask you for a number of details of your application, including the\n   `name` of your application (which should be a valid PyPI identifier), and\n   the `Formal Name` of your application (the full name you use to describe\n   your app). The remainder of these instructions will assume a `name` of\n   ``my-project``, and a formal name of ``My Project``.\n\n3. `Obtain a Python Apple support package for iOS`_, and extract it into\n   the ``My Project`` directory generated by the template. This will give you a\n   ``My Project/Support`` directory containing a self contained Python install.\n\n4. Add your code to the template, into the ``My Project/my-project/app``.\n   directory. At the very minimum, you need to have an\n   ``app/\u003capp name\u003e/__main__.py`` file that defines a ``PythonAppDelegate``\n   class.\n\n   If your code has any dependencies, they should be installed into the\n   ``My Project/my-project/app_packages`` directory.\n\nIf you've done this correctly, a project with a formal name of ``My Project``,\nwith an app name of ``my-project`` should have a directory structure that\nlooks something like::\n\n    My Project/\n        my-project/\n            app/\n                my_project/\n                    __init__.py\n                    app.py (declares PythonAppDelegate)\n            app_packages/\n                ...\n            ...\n        My Project.xcodeproj/\n            ...\n        Support/\n            ...\n        briefcase.toml\n\nYou're now ready to open the XCode project file, build and run your project!\n\nNext steps\n----------\n\nOf course, running Python code isn't very interesting by itself - you'll be\nable to output to the console, and see that output in XCode, but if you tap the\napp icon on your phone, you won't see anything - because there isn't a visible\nconsole on an iPhone.\n\nTo do something interesting, you'll need to work with the native iOS system\nlibraries to draw widgets and respond to screen taps. The `Rubicon`_ Objective\nC bridging library can be used to interface with the iOS system libraries.\nAlternatively, you could use a cross-platform widget toolkit that supports iOS\n(such as `Toga`_) to provide a GUI for your application.\n\nRegardless of whether you use Toga, or you write an application natively, the\ntemplate project will try to instantiate a ``UIApplicationMain`` instance,\nusing a class named ``PythonAppDelegate`` as the App delegate. If a class of\nthat name can't be instantiated, the error raised will be logged, and the\nPython interpreter will be shut down.\n\nIf you have any external library dependencies (like Toga, or anything other\nthird-party library), you should install the library code into the\n``app_packages`` directory. This directory is the same as a  ``site_packages``\ndirectory on a desktop Python install.\n\n.. _cookiecutter: https://github.com/cookiecutter/cookiecutter\n.. _Obtain a Python Apple support package for iOS: https://github.com/beeware/Python-Apple-support\n.. _Rubicon: https://github.com/beeware/rubicon-objc\n.. _Toga: https://beeware.org/project/projects/libraries/toga\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-ios-xcode-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fbriefcase-ios-xcode-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbriefcase-ios-xcode-template/lists"}