| Name | iOSBuild JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A Python script for creating XCFrameworks for CMake projects |
| upload_time | 2025-02-19 13:03:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2025 Zack Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
apple
cmake
macos
xcframework
ios
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# iOSBuild
[](https://www.apple.com/macos/)
[](https://www.python.org)
[](https://github.com/zwill22/iOSBuild/blob/main/LICENSE)
[](https://github.com/zwill22/iosbuild)
[](https://github.com/zwill22/iOSBuild/actions/workflows/python-package.yml)
[](https://iosbuild.readthedocs.io/en/latest)
[](https://iosbuild.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/zwill22/iOSBuild)
Welcome to iOSBuild, a Python application for building CMake libraries for Apple systems.
The aim of the project is to use a `CMakeLists.txt` file to generate an
[XCFramework](https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle)
containing static libraries for use across iOS and other Apple operating systems.
This project makes use of the [ios-cmake toolchain](https://github.com/leetal/ios-cmake)
to configure and build the libraries using [CMake](https://cmake.org).
The libraries are built for each of the specified platforms and combined into a single `xcframework`
for each library. These may then be included in iOS, watchOS, visionOS, tvOS, and macOS applications [using Xcode](https://github.com/zwill22/blogs/blob/main/linking.md#adding-xcframeworks-to-xcode).
## Pre-requisites
In order to run the code there are a number of non-Python projects which must be installed:
- [CMake](https://cmake.org/cmake/help/latest/) (minimum tested version 3.22)
- [XCode](https://developer.apple.com/xcode/) (command line tools)
- [Apple SDKs](https://developer.apple.com/support/xcode/) for each of the specified targets
- [Python](https://docs.python.org/3/) (versions 3.9-3.13 supported)
Optional Dependencies:
- [Pytest](https://docs.pytest.org/en/stable/) (for testing)
- [Sphinx](https://www.sphinx-doc.org/en/master/) (for building documentation)
Since the project requires XCode and the SDK for each target platform, the project only works for macOS.
## Getting started
This repository includes a simple example `CMake` project for testing the build system.
To build using `pip` from this repo:
```
pip install iosbuild
pip -m ios_build -v example
```
This builds the example project using sensible defaults for iOS (ARM64), iOS Simulator (ARM64),
and macOS (ARM64). This configuration builds the files in a subdirectory `build` of the current
directory, downloads the `ios.toolchain.cmake` file to the current directory and installs the libraries
and the `xcframework` to `install`.
If successful, this outputs a file `libiosbuildexample.xcframeworks` in the `install/` directory.
Raw data
{
"_id": null,
"home_page": null,
"name": "iOSBuild",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Apple, CMake, MacOS, XCFramework, iOS",
"author": null,
"author_email": "Z M Williams <z.m.will@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/91/ce/a51a0f62171897b1b7b75135393663991cc19ebcd19dacfec020c5abaa91/iosbuild-0.2.0.tar.gz",
"platform": null,
"description": "# iOSBuild\n\n[](https://www.apple.com/macos/)\n[](https://www.python.org)\n[](https://github.com/zwill22/iOSBuild/blob/main/LICENSE)\n[](https://github.com/zwill22/iosbuild)\n[](https://github.com/zwill22/iOSBuild/actions/workflows/python-package.yml)\n[](https://iosbuild.readthedocs.io/en/latest)\n[](https://iosbuild.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/zwill22/iOSBuild)\n\n\nWelcome to iOSBuild, a Python application for building CMake libraries for Apple systems.\nThe aim of the project is to use a `CMakeLists.txt` file to generate an\n[XCFramework](https://developer.apple.com/documentation/xcode/creating-a-multi-platform-binary-framework-bundle)\ncontaining static libraries for use across iOS and other Apple operating systems.\n\nThis project makes use of the [ios-cmake toolchain](https://github.com/leetal/ios-cmake) \nto configure and build the libraries using [CMake](https://cmake.org).\nThe libraries are built for each of the specified platforms and combined into a single `xcframework`\nfor each library. These may then be included in iOS, watchOS, visionOS, tvOS, and macOS applications [using Xcode](https://github.com/zwill22/blogs/blob/main/linking.md#adding-xcframeworks-to-xcode).\n\n## Pre-requisites \n\nIn order to run the code there are a number of non-Python projects which must be installed:\n- [CMake](https://cmake.org/cmake/help/latest/) (minimum tested version 3.22)\n- [XCode](https://developer.apple.com/xcode/) (command line tools)\n- [Apple SDKs](https://developer.apple.com/support/xcode/) for each of the specified targets\n- [Python](https://docs.python.org/3/) (versions 3.9-3.13 supported)\n\nOptional Dependencies:\n- [Pytest](https://docs.pytest.org/en/stable/) (for testing)\n- [Sphinx](https://www.sphinx-doc.org/en/master/) (for building documentation)\n\nSince the project requires XCode and the SDK for each target platform, the project only works for macOS.\n\n## Getting started\n\nThis repository includes a simple example `CMake` project for testing the build system.\n\nTo build using `pip` from this repo:\n```\npip install iosbuild\npip -m ios_build -v example\n```\nThis builds the example project using sensible defaults for iOS (ARM64), iOS Simulator (ARM64), \nand macOS (ARM64). This configuration builds the files in a subdirectory `build` of the current \ndirectory, downloads the `ios.toolchain.cmake` file to the current directory and installs the libraries \nand the `xcframework` to `install`. \nIf successful, this outputs a file `libiosbuildexample.xcframeworks` in the `install/` directory.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Zack Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Python script for creating XCFrameworks for CMake projects",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://iosbuild.readthedocs.io/en/latest/",
"Repository": "https://github.com/zwill22/iOSBuild"
},
"split_keywords": [
"apple",
" cmake",
" macos",
" xcframework",
" ios"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ad317629b795429a51f55c92f1bf3793f382dc243b21d3e6a56e07d9f5c2b2cb",
"md5": "d856f9402ca861e79ce82167a93764cb",
"sha256": "521c237749e0071702fdc4a0232d2039562deddee4846af474f57469765fe8b4"
},
"downloads": -1,
"filename": "iosbuild-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d856f9402ca861e79ce82167a93764cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17089,
"upload_time": "2025-02-19T13:03:34",
"upload_time_iso_8601": "2025-02-19T13:03:34.262191Z",
"url": "https://files.pythonhosted.org/packages/ad/31/7629b795429a51f55c92f1bf3793f382dc243b21d3e6a56e07d9f5c2b2cb/iosbuild-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "91cea51a0f62171897b1b7b75135393663991cc19ebcd19dacfec020c5abaa91",
"md5": "21f12b594a01acc1f885cdbc3afa0287",
"sha256": "4bd8c48bfc1c8204f680de459d1d11861438237674cf90e74fd2ee808134abb1"
},
"downloads": -1,
"filename": "iosbuild-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "21f12b594a01acc1f885cdbc3afa0287",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22533,
"upload_time": "2025-02-19T13:03:36",
"upload_time_iso_8601": "2025-02-19T13:03:36.190856Z",
"url": "https://files.pythonhosted.org/packages/91/ce/a51a0f62171897b1b7b75135393663991cc19ebcd19dacfec020c5abaa91/iosbuild-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 13:03:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zwill22",
"github_project": "iOSBuild",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "iosbuild"
}
