{"id":13420389,"url":"https://github.com/libimobiledevice/libplist","last_synced_at":"2025-05-15T23:07:35.062Z","repository":{"id":714791,"uuid":"8180632","full_name":"libimobiledevice/libplist","owner":"libimobiledevice","description":"A library to handle Apple Property List format in binary or XML","archived":false,"fork":false,"pushed_at":"2025-04-06T10:38:42.000Z","size":1664,"stargazers_count":572,"open_issues_count":37,"forks_count":315,"subscribers_count":49,"default_branch":"master","last_synced_at":"2025-05-11T12:47:20.265Z","etag":null,"topics":["c","cpp","library","plist","xml"],"latest_commit_sha":null,"homepage":"https://libimobiledevice.org","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libimobiledevice.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-02-13T14:30:43.000Z","updated_at":"2025-05-09T03:12:04.000Z","dependencies_parsed_at":"2023-07-05T20:03:06.751Z","dependency_job_id":"3c235071-6404-4ba3-b351-c128f192e648","html_url":"https://github.com/libimobiledevice/libplist","commit_stats":{"total_commits":917,"total_committers":54,"mean_commits":16.98148148148148,"dds":0.5223555070883314,"last_synced_commit":"bfc97788f081584ced9cd35d85b69b3fec6b907c"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibplist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibplist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibplist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibplist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libimobiledevice","download_url":"https://codeload.github.com/libimobiledevice/libplist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436948,"owners_count":22070947,"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":["c","cpp","library","plist","xml"],"created_at":"2024-07-30T22:01:32.638Z","updated_at":"2025-05-15T23:07:29.116Z","avatar_url":"https://github.com/libimobiledevice.png","language":"C","funding_links":[],"categories":["TODO scan for Android support in followings","Uncategorized","C"],"sub_categories":["Uncategorized"],"readme":"# libplist\n\n*A small portable C library to handle Apple Property List files in binary, XML,\nJSON, or OpenStep format.*\n\n![](https://github.com/libimobiledevice/libplist/workflows/build/badge.svg)\n![](https://github.com/libimobiledevice/libplist/workflows/CodeQL/badge.svg)\n\n## Table of Contents\n- [Features](#features)\n- [Building](#building)\n  - [Prerequisites](#prerequisites)\n    - [Linux (Debian/Ubuntu based)](#linux-debianubuntu-based)\n    - [macOS](#macos)\n    - [Windows](#windows)\n  - [Configuring the source tree](#configuring-the-source-tree)\n  - [Building and installation](#building-and-installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [Links](#links)\n- [License](#license)\n- [Credits](#credits)\n\n## Features\n\nThe project provides an interface to read and write plist files in binary,\nXML, JSON, or OpenStep format alongside a command-line utility named `plistutil`.\n\nSome key features are:\n\n- **Formats:** Supports binary, XML, JSON, and OpenStep format\n- **Utility:** Provides a `plistutil` utility for the command-line\n- **Python:** Provides Cython based bindings for Python\n- **Tested:** Uses fuzzing ([OSS-Fuzz](https://github.com/google/oss-fuzz)) and data compliance tests\n- **Efficient:** Lean library with performance and resources in mind\n\n## Building\n\n### Prerequisites\n\nYou need to have a working compiler (gcc/clang) and development environent\navailable. This project uses autotools for the build process, allowing to\nhave common build steps across different platforms.\nOnly the prerequisites differ and they are described in this section.\n\n#### Linux (Debian/Ubuntu based)\n\n* Install all required dependencies and build tools:\n  ```shell\n  sudo apt-get install \\\n\tbuild-essential \\\n\tcheckinstall \\\n\tgit \\\n\tautoconf \\\n\tautomake \\\n\tlibtool-bin\n  ```\n\n  If you want to optionally build the documentation or Python bindings use:\n  ```shell\n  sudo apt-get install \\\n  \tdoxygen \\\n  \tcython3\n  ```\n\n#### macOS\n\n* Make sure the Xcode command line tools are installed. Then, use either [MacPorts](https://www.macports.org/)\n  or [Homebrew](https://brew.sh/) to install `automake`, `autoconf`, and `libtool`.\n\n  Using MacPorts:\n  ```shell\n  sudo port install libtool autoconf automake\n  ```\n\n  Using Homebrew:\n  ```shell\n  brew install libtool autoconf automake\n  ```\n\n  In case you want to build the documentation, install `doxygen` using the corresponding install command from above.\n\n  If you want to build Python bindings, you need to install cython:\n  ```shell\n  pip3 install cython\n  ```\n\n  You might need to set a few environment variables if building of the Python bindings fail. For example, the [automated build via GitHub actions](https://github.com/libimobiledevice/libplist/blob/master/.github/workflows/build.yml)\n  is setting the following environment variables:\n  ```shell\n  PYTHON3_BIN=`xcrun -f python3`\n  export PYTHON=$PYTHON3_BIN\n  PYTHON_VER=`$PYTHON3_BIN -c \"import distutils.sysconfig; print(distutils.sysconfig.get_config_var('VERSION'))\"`\n  PYTHON_EXEC_PREFIX=`$PYTHON3_BIN -c \"import distutils.sysconfig; print(distutils.sysconfig.get_config_var('exec_prefix'))\"`\n  PYTHON_LIBS_PATH=$PYTHON_EXEC_PREFIX/lib\n  PYTHON_FRAMEWORK_PATH=$PYTHON_EXEC_PREFIX/Python3\n  export PYTHON_LIBS=\"-L$PYTHON_LIBS_PATH -lpython$PYTHON_VER\"\n  export PYTHON_EXTRA_LDFLAGS=\"-Wl,-stack_size,1000000  -framework CoreFoundation $PYTHON_FRAMEWORK_PATH\"\n  ```\n\n#### Windows\n\n* Using [MSYS2](https://www.msys2.org/) is the official way of compiling this project on Windows. Download the MSYS2 installer\n  and follow the installation steps.\n\n  It is recommended to use the _MSYS2 MinGW 64-bit_ shell. Run it and make sure the required dependencies are installed:\n\n  ```shell\n  pacman -S base-devel \\\n  \tgit \\\n  \tmingw-w64-x86_64-gcc \\\n  \tmake \\\n  \tlibtool \\\n  \tautoconf \\\n  \tautomake-wrapper\n  ```\n  NOTE: You can use a different shell and different compiler according to your needs. Adapt the above command accordingly.\n\n  If you want to optionally build Python bindings, you need to also install `cython`\n  and make sure you have a working python environment.\n\n  ```shell\n  pacman -S cython\n  ```\n\n### Configuring the source tree\n\nYou can build the source code from a git checkout, or from a `.tar.bz2` release tarball from [Releases](https://github.com/libimobiledevice/libplist/releases).\nBefore we can build it, the source tree has to be configured for building. The steps depend on where you got the source from.\n\n* **From git**\n\n  If you haven't done already, clone the actual project repository and change into the directory.\n  ```shell\n  git clone https://github.com/libimobiledevice/libplist.git\n  cd libplist\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./autogen.sh\n  ```\n\n* **From release tarball (.tar.bz2)**\n\n  When using an official [release tarball](https://github.com/libimobiledevice/libplist/releases) (`libplist-x.y.z.tar.bz2`)\n  the procedure is slightly different.\n\n  Extract the tarball:\n  ```shell\n  tar xjf libplist-x.y.z.tar.bz2\n  cd libplist-x.y.z\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./configure\n  ```\n\nBoth `./configure` and `./autogen.sh` (which generates and calls `configure`) accept a few options, for example `--enable-debug` to allow\nprinting debug messages in the final product, or `--without-cython` to skip building the Python bindings.\nYou can simply pass them like this:\n\n```shell\n./autogen.sh --prefix=/usr/local --enable-debug --without-cython\n```\nor\n```shell\n./configure --prefix=/usr/local --enable-debug\n```\n\nOnce the command is successful, the last few lines of output will look like this:\n```\n[...]\nconfig.status: creating config.h\nconfig.status: executing depfiles commands\nconfig.status: executing libtool commands\n\nConfiguration for libplist 2.3.1:\n-------------------------------------------\n\n  Install prefix ..........: /usr/local\n  Debug code ..............: yes\n  Python bindings .........: yes\n\n  Now type 'make' to build libplist 2.3.1,\n  and then 'make install' for installation.\n```\n\n### Building and installation\n\nIf you followed all the steps successfully, and `autogen.sh` or `configure` did not print any errors,\nyou are ready to build the project. This is simply done with\n\n```shell\nmake\n```\n\nIf no errors are emitted you are ready for installation. Depending on whether\nthe current user has permissions to write to the destination directory or not,\nyou would either run\n```shell\nmake install\n```\n_OR_\n```shell\nsudo make install\n```\n\nIf you are on Linux, you want to run `sudo ldconfig` after installation to\nmake sure the installed libraries are made available.\n\n## Usage\n\nUsage is simple; `libplist` has a straight-forward API. It is used in [libimobiledevice](https://github.com/libimobiledevice/libimobiledevice)\nand [corresponding projects](https://github.com/libimobiledevice/).\n\nFurthermore, it comes with a command line utility `plistutil` that is really easy to use:\n```shell\nplistutil -i foobar.plist -o output.plist\n```\nThis converts the `foobar.plist` file to the opposite format, e.g. binary to\nXML or vice versa, and outputs it to the `output.plist` file.\n\nTo convert to a specific format - and also to convert from JSON or OpenStep\nformat - use the `-f` command line switch:\n```shell\nplistutil -i input.plist -f json\n```\nThis will convert `input.plist`, regardless of the input format, to JSON. The\ncode auto-detects the input format and parses it accordingly.\n\nPlease consult the usage information or manual page for a full documentation of\navailable command line options:\n```shell\nplistutil --help\n```\nor\n```shell\nman plistutil\n```\n\n## Contributing\n\nWe welcome contributions from anyone and are grateful for every pull request!\n\nIf you'd like to contribute, please fork the `master` branch, change, commit and\nsend a pull request for review. Once approved it can be merged into the main\ncode base.\n\nIf you plan to contribute larger changes or a major refactoring, please create a\nticket first to discuss the idea upfront to ensure less effort for everyone.\n\nPlease make sure your contribution adheres to:\n* Try to follow the code style of the project\n* Commit messages should describe the change well without being too short\n* Try to split larger changes into individual commits of a common domain\n* Use your real name and a valid email address for your commits\n\n## Links\n\n* Homepage: https://libimobiledevice.org/\n* Repository: https://github.com/libimobiledevice/libplist.git\n* Repository (Mirror): https://git.libimobiledevice.org/libplist.git\n* Issue Tracker: https://github.com/libimobiledevice/libplist/issues\n* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel\n* Twitter: https://twitter.com/libimobiledev\n\n## License\n\nThis project is licensed under the [GNU Lesser General Public License v2.1](https://www.gnu.org/licenses/lgpl-2.1.en.html),\nalso included in the repository in the `COPYING` file.\n\n## Credits\n\nApple, iPhone, iPad, iPod, iPod Touch, Apple TV, Apple Watch, Mac, iOS,\niPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.\n\nThis project is an independent software library and has not been authorized,\nsponsored, or otherwise approved by Apple Inc.\n\nREADME Updated on: 2024-10-22\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibplist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibimobiledevice%2Flibplist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibplist/lists"}