Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/kronenthaler/mod-pbxproj

A python module to manipulate XCode projects
https://github.com/kronenthaler/mod-pbxproj

cli hacktoberfest library pbxproj python xcode

Last synced: 3 months ago
JSON representation

A python module to manipulate XCode projects

Lists

README 

        

.. image:: https://img.shields.io/github/actions/workflow/status/kronenthaler/mod-pbxproj/branch-check.yml?event=push&style=flat&logo=github&color=4da533

   :target: https://github.com/kronenthaler/mod-pbxproj/actions?query=workflow%3Abranch-check

   :alt: GitHub Workflow Status (branch)



.. image:: https://sonarcloud.io/api/project_badges/measure?project=kronenthaler_mod-pbxproj&metric=alert_status

   :target: https://sonarcloud.io/summary/new_code?id=kronenthaler_mod-pbxproj

   :alt: Sonar Quality Gate status



.. image:: https://sonarcloud.io/api/project_badges/measure?project=kronenthaler_mod-pbxproj&metric=coverage

   :target: https://sonarcloud.io/component_measures?metric=coverage&id=kronenthaler_mod-pbxproj

   :alt: Sonar branch coverage



.. image:: https://sonarcloud.io/api/project_badges/measure?project=kronenthaler_mod-pbxproj&metric=reliability_rating

   :target: https://sonarcloud.io/summary/new_code?id=kronenthaler_mod-pbxproj

   :alt: Sonar reliability grade



.. image:: https://img.shields.io/pypi/v/pbxproj?logo=python&logoColor=ffffff&style=flat&color=4da533

   :target: https://pypi.python.org/pypi/pbxproj

   :alt: PyPI



.. image:: https://img.shields.io/pypi/dm/pbxproj?logo=python&logoColor=ffffff&style=flat&color=4da533

   :target: https://pypi.python.org/pypi/pbxproj/

   :alt: PyPI - Downloads



.. image:: https://img.shields.io/pypi/l/pbxproj?style=flat&color=4da533

   :target: license.txt

   :alt: PyPI - License



pbxproj

=======



This module can read, modify, and write a .pbxproj file from an Xcode 4+ projects. The file is usually called project.pbxproj and can be found inside the .xcodeproj bundle. Because some task cannot be done by clicking on an UI or opening Xcode to do it for you, this python module lets you automate the modification process.



How to use it

-------------



The typical tasks with an Xcode project are adding files to the project and setting some standard compilation flags.

It can be achieved with a simple snippet like this:



.. code-block:: python



   from pbxproj import XcodeProject

   # open the project

   project = XcodeProject.load('myapp.xcodeproj/project.pbxproj')



   # add a file to it, force=false to not add it if it's already in the project

   project.add_file('MyClass.swift', force=False)



   # set a Other Linker Flags

   project.add_other_ldflags('-ObjC')



   # save the project, otherwise your changes won't be picked up by Xcode

   project.save()



That's it. More details about available API's visit the `wiki `__.



Installation

------------



For installation instructions visit the `wiki `__



CLI

---



For instructions and commands available visit the `wiki `__



Documentation

-------------



For general documentation, visit the `wiki `_.

For technical documentation, the public functions are documented and contains details about what is expected.



Reporting bugs

--------------



Did you find a bug? Too bad, but we want to help you, we need you to:



* Check you are running python3 and installed the package using the pip3 command.

* Provide as many details about the error you are having.

* If possible provide a sample project.pbxproj to reproduce the steps 

* If possible, try the sequence of steps on Xcode and provide the project.pbxproj generated by Xcode.



We cannot help you if your issue is a title: "it does not work". Or if there is no sequence of steps to reproduce the error. Those kind of issues will be ignored or closed automatically.



Contributing

------------



Do you want to fix an issue yourself? Great! some house rules:



* Provide a description of what problem you are solving, what case was not being taking into account

* Provide unit tests for the case you have fixed. Pull request without unit test or PRs that decrease the coverage will not be approved until this changes.

* Adhere to the coding style and conventions of the project, for instance, target_name is used to specify the target across all functions that use this parameter. Changes will be requested on PRs that don't follow this.

* Write descriptive commit messages.



License

-------



This project is licensed using MIT license.