xcodeproj

xcodeproj is a utility for interacting with Xcode's xcodeproj bundle format.

It expects some level of understanding of the internals of the pbxproj format and, in the future, schemes, etc. Note that this tool only reads projects. It does not write out any changes. If you are looking for more advanced functionality like this, I recommend looking at the Ruby gem of the same name (which is unaffiliated in anyway).

To learn more about the format, you can look at any of these locations:

Getting Started

Loading a project is very simple:

project = xcodeproj.XcodeProject("/path/to/project.xcodeproj")

From here you can explore the project in different ways:

# Get all targets
for target in project.targets:
    print(target.name)

# Print from the root level, 2 levels deep (.project is a property on the root 
# project as in the future more surfaces, such as schemes, will be exposed)
for item1 in project.project.main_group.children:
    print(item1)
    if not isinstance(item1, xcodeproj.PBXGroup):
        continue

    for item2 in item1.children:
        print("\t", item2)

# Check that all files referenced in the project exist on disk
for item in project.fetch_type(xcodeproj.PBXFileReference).values():
    assert os.path.exists(item.absolute_path())

# You can access the raw objects map directly:
obj = project.objects["key here"]

# For any object you have, you can access its key/identifier via the 
# `.object_key` property
key = obj.object_key

Note: This library is "lazy". Many things aren't calculated until they are used. This time will be inconsequential on smaller projects, but on larger ones, it can save quite a bit of time due to not parsing the entire project on load. These properties are usually stored though so that subsequent accesses are instant.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Metadata

Release files for xcodeproj 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xcodeproj 0.4.1
File	Size	Uploaded
xcodeproj-0.4.1.tar.gz	12.1 kB	Mar 22, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for xcodeproj 0.4.1
File	Interpreter	ABI	Platform	Reset
xcodeproj-0.4.1-py3-none-any.whl 13.6 kB Mar 22, 2021	Python 3	none	any	Details

Total release size: 25.7 kB

Release files / xcodeproj-0.4.1.tar.gz

Download URL	xcodeproj-0.4.1.tar.gz
Size	12.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`4e10b7cf3cf7833306188977a72f45df964e65ce31f04ecc5d5b93647c045c22`
BLAKE2b-256 checksum How to use checksums	`5759d832048be77eae6cafbba54dd89185b6125d406298403b31b99ef3af2e2f`
Upload date	Mar 22, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.5 CPython/3.9.2 Darwin/20.3.0`

Release files / xcodeproj-0.4.1-py3-none-any.whl

Download URL	xcodeproj-0.4.1-py3-none-any.whl
Size	13.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`fef8f75db24b96fd7f2c47a98272459243fa38b8cd68ece6230b8bccc90525fe`
BLAKE2b-256 checksum How to use checksums	`722ca936bf678e415e26a0a494ec9405e42ae5f05bd408e75b42acd33faa5275`
Upload date	Mar 22, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.5 CPython/3.9.2 Darwin/20.3.0`