Describe this repo as unmaintained in the readme

The libloot repo's Python wrapper is experimental and may not be kept, so link to a specific commit that has it and word the message to be true even if the wrapper is removed in the future.

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: CI
+
+on:
+  push:
+    # Don't run this workflow when a tag is pushed.
+    branches:
+      - '*'
+  pull_request:
+
+env:
+  MSVC_CONFIG: RelWithDebInfo
+
+jobs:
+  windows:
+    runs-on: windows-2025
+
+    strategy:
+      matrix:
+        platform: [Win32, x64]
+        python-version: [3.7]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Get Python architecture
+        id: get-python-architecture
+        shell: bash
+        run: |
+          if [[ "${{ matrix.platform }}" == "Win32" ]]
+          then
+            PLATFORM=x86
+          else
+            PLATFORM=x64
+          fi
+          echo "architecture=$PLATFORM" >> $GITHUB_OUTPUT
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ steps.get-python-architecture.outputs.architecture }}
+
+      - name: Get descriptive version
+        id: get-version
+        shell: bash
+        run: |
+          GIT_DESCRIBE=$(git describe --tags --long --abbrev=7)
+          DESC_REF=${GIT_DESCRIBE}_${GITHUB_REF#refs/*/}
+          SAFE_DESC_REF=${DESC_REF//[\/<>\"|]/_}
+          echo "version=$SAFE_DESC_REF" >> $GITHUB_OUTPUT
+
+      - name: Run CMake
+        run: |
+          mkdir build
+          cd build
+          cmake .. -G "Visual Studio 17 2022" -A ${{ matrix.platform }} -DCPACK_PACKAGE_VERSION="${{ steps.get-version.outputs.version }}-python${{ matrix.python-version }}"
+          cmake --build . --config ${{ env.MSVC_CONFIG }}
+
+      - name: Run tests
+        run: |
+          cd build
+          ctest -C ${{ env.MSVC_CONFIG }}
+
+      - name: Build archive
+        id: build-archive
+        shell: bash
+        run: |
+          cd build
+          cpack -C ${{ env.MSVC_CONFIG }}
+
+          VERSION="${{ steps.get-version.outputs.version }}-python${{ matrix.python-version }}"
+          if [[ "${{ matrix.platform }}" == "Win32" ]]
+          then
+            PLATFORM=win32
+          else
+            PLATFORM=win64
+          fi
+
+          echo "filename=libloot-python-${VERSION}-${PLATFORM}.zip" >> $GITHUB_OUTPUT
+
+      - name: Upload archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.build-archive.outputs.filename }}
+          path: build/package/${{ steps.build-archive.outputs.filename }}
+        if: github.event_name == 'push'

.github/workflows/release.yml

@@ -0,0 +1,92 @@
+name: Release
+
+on:
+  push:
+    tags: '*'
+
+env:
+  MSVC_CONFIG: RelWithDebInfo
+
+jobs:
+  create_release:
+    runs-on: ubuntu-18.04
+    outputs:
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+      git_tag: ${{ steps.get-git-tag.outputs.name }}
+
+    steps:
+      - name: Get Git tag
+        id: get-git-tag
+        run: echo "name=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
+
+      - id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.get-git-tag.outputs.name }}
+          release_name: libloot-python v${{ steps.get-git-tag.outputs.name }}
+          body: |
+            Requires Windows 7 or later and the [MSVC 2022 x86 redistributable](https://aka.ms/vs/17/release/vc_redist.x86.exe), and [7-Zip](http://www.7-zip.org/) to extract the archive.
+
+  windows:
+    runs-on: windows-2025
+    needs: create_release
+
+    strategy:
+      matrix:
+        platform: [Win32, x64]
+        python-version: [3.7]
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Get descriptive version
+        id: get-version
+        shell: bash
+        run: |
+          GIT_DESCRIBE=$(git describe --tags --long --abbrev=7)
+          DESC_REF=${GIT_DESCRIBE}_${GITHUB_REF#refs/*/}
+          SAFE_DESC_REF=${DESC_REF//[\/<>\"|]/_}
+          echo "version=$SAFE_DESC_REF" >> $GITHUB_OUTPUT
+
+      - name: Run CMake
+        run: |
+          mkdir build
+          cd build
+          cmake .. -G "Visual Studio 17 2022" -A ${{ matrix.platform }} -DCPACK_PACKAGE_VERSION="${{ steps.get-version.outputs.version }}-python${{ matrix.python-version }}"
+          cmake --build . --config ${{ env.MSVC_CONFIG }}
+
+      - name: Build archive
+        id: build-archive
+        shell: bash
+        run: |
+          cd build
+          cpack -C ${{ env.MSVC_CONFIG }}
+
+          VERSION="${{ steps.get-version.outputs.version }}-python${{ matrix.python-version }}"
+          if [[ "${{ matrix.platform }}" == "Win32" ]]
+          then
+            PLATFORM=win32
+          else
+            PLATFORM=win64
+          fi
+
+          echo "filename=libloot-python-${VERSION}-${PLATFORM}.zip" >> $GITHUB_OUTPUT
+
+      - name: Upload Archive
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create_release.outputs.upload_url }}
+          asset_path: build/package/${{ steps.build-archive.outputs.filename }}
+          asset_name: ${{ steps.build-archive.outputs.filename }}
+          asset_content_type: application/x-7z-compressed

.gitignore

@@ -50,3 +50,5 @@ $RECYCLE.BIN/
 
 # Windows shortcuts
 *.lnk
+
+.vscode/

.travis.yml

@@ -1,49 +0,0 @@
-sudo: false
-language: cpp
-compiler: gcc
-
-addons:
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test           # ppa:ubuntu-toolchain-r/test
-    packages:
-      - gcc-5
-      - g++-5
-      - wget
-
-install:
-  # Use GCC 5.
-  - if [ "$CXX" = "g++" ]; then export CXX="g++-5" CC="gcc-5"; fi
-  # Download CMake binary because those available in PPAs either don't support
-  # xz downloads or don't support HTTPS.
-  - wget https://cmake.org/files/v3.6/cmake-3.6.2-Linux-x86_64.tar.gz
-  - tar -xf cmake-3.6.2-Linux-x86_64.tar.gz
-
-before_script:
-  # Move into the cloned LOOT repo build path.
-  - mkdir build && cd build
-  # Link dynamically to the C++ standard library runtime.
-  - ../cmake-3.6.2-Linux-x86_64/bin/cmake ..
-
-script:
-  - make all
-  - python -m unittest test
-
-after_success:
-  # Get the full repo history before trying to run the archiver.
-  - git fetch --unshallow
-  - ../cmake-3.6.2-Linux-x86_64/bin/cpack
-  - cd $TRAVIS_BUILD_DIR
-  # Need to replace the Bintray config files' version placeholders.
-  - VERSION=$(ls build/package/loot_api_python-*.tar.xz | sed 's/build\/package\/loot_api_python-//;s/-Linux.tar.xz//;')
-  - sed -i "s/REPLACE_THIS_VERSION/${VERSION}_${TRAVIS_BRANCH}/" scripts/travis/loot-api.bintray.json
-
-deploy:
-  - provider: bintray
-    file: scripts/travis/loot-api.bintray.json
-    user: wrinklyninja
-    key:
-      secure: "XUj1hk5lNhyzPNs3iv1kw8h370QrS+hOcGvj7fMkMb3KQF+I7XJIIhi5lcVd/X5NB79M4IYKac+7n4fVPsf6jXd+SpKYKdPF5ZnSn00dtU34Jhz+DiZQoLdAVLhGgOTLxv2SE6kfvfCXXVlSSoVOVNH0rx0OWE/BjZaSxd9+XeQgEJ/qozvt9kl4sd02y/M4r9h4SAMGf3zav+PWy+5cigy/LFONDQ9oeCEOJmVbazlB2Hkt0GnRkPpW/jFjUvt5qs0jS1neBBmeVCxvue1qJVJBwPtIszNhoARn/mY1tfQ4b0MdzvYhK1kjHvtBLW+OoXOr5VaiZ2a0J+t7jtgfO2cadiIgqCbxddltq1CESFa3pSCpkAfSg1jkl3Lj7BJzSLrRLxySN+Hq0O4qR3A3cQOVt5glZIbabq0h1b9jxZSpU9D+jwgZxxmI8NZJRS4TegZ+Q1ygY/MrSydUWQ3fK0ls20GePKjPtK90ipqt0HLyjAcLLVshc1jB3MPqDKEPXnQtxrJmbHwZu2rzlngIjUNybJXQxuJLqcE/awijpoftbqxctXzEq2hMj/lp6Y4agX++hikPg+BP6HHCwuwgXTYkcUXC6v5Mm2NTboDnimiJq2aCzcgc4RVjes1o5cKng8xtpYCNoTkEd4Tu1DL+AR6tJnjXkvRsJCdBWUVIFG4="
-    skip_cleanup: true
-    on:
-      all_branches: true

CMakeLists.txt

@@ -1,15 +1,23 @@
 
-cmake_minimum_required (VERSION 2.8.12)
+cmake_minimum_required (VERSION 3.4)
-project (loot_api_python)
+project (libloot-python)
 include(ExternalProject)
 
 set(EXTERNAL_PROJECTS_PATH "${CMAKE_BINARY_DIR}/external/src")
 make_directory(${EXTERNAL_PROJECTS_PATH})
 
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
 ##############################
 # Get Build Revision
 ##############################
 
+set(LIBLOOT_PY_VERSION_MAJOR 4)
+set(LIBLOOT_PY_VERSION_MINOR 0)
+set(LIBLOOT_PY_VERSION_PATCH 2)
+
 find_package(Git)
 
 IF (GIT_FOUND)
@@ -21,18 +29,21 @@ ELSE()
     SET (GIT_COMMIT_STRING "unknown")
 ENDIF ()
 
+message(STATUS "libloot-python version: ${LIBLOOT_PY_VERSION_MAJOR}.${LIBLOOT_PY_VERSION_MINOR}.${LIBLOOT_PY_VERSION_PATCH}")
 message(STATUS "Git revision: ${GIT_COMMIT_STRING}")
 
 # Write to file.
 configure_file("${CMAKE_SOURCE_DIR}/src/wrapper_version.cpp.in" "${CMAKE_BINARY_DIR}/generated/wrapper_version.cpp" @ONLY)
+configure_file("${CMAKE_SOURCE_DIR}/python/setup.py" "${CMAKE_BINARY_DIR}/generated/setup.py" @ONLY)
 
 #######################################
 # pybind11
 #######################################
 
-set(PYBIND11_URL "https://github.com/pybind/pybind11/archive/v1.8.1.tar.gz")
+set(PYBIND11_VERSION "2.9.2")
-set(PYBIND11_DOWNLOAD_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-1.8.1.tar.gz")
+set(PYBIND11_URL "https://github.com/pybind/pybind11/archive/v${PYBIND11_VERSION}.tar.gz")
-set(PYBIND11_EXTRACTED_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-1.8.1")
+set(PYBIND11_DOWNLOAD_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-${PYBIND11_VERSION}.tar.gz")
+set(PYBIND11_EXTRACTED_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-${PYBIND11_VERSION}")
 
 if (NOT EXISTS ${PYBIND11_DOWNLOAD_PATH})
     file(DOWNLOAD ${PYBIND11_URL} ${PYBIND11_DOWNLOAD_PATH})
@@ -45,53 +56,52 @@ execute_process(COMMAND ${CMAKE_COMMAND} -E tar xfz ${PYBIND11_DOWNLOAD_PATH}
 add_subdirectory(${PYBIND11_EXTRACTED_PATH})
 
 #######################################
-# LOOT API
+# libloot
 #######################################
 
 if (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    set(LOOT_API_URL "https://bintray.com/wrinklyninja/loot/download_file?file_path=loot-api_0.10.0-0-g7b97241_dev.7z")
+    if (NOT "${CMAKE_GENERATOR_PLATFORM}" MATCHES "x64")
+        set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.15.0/libloot-0.15.0-0-g629fdab_master-win32.7z")
+    else()
+        set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.15.0/libloot-0.15.0-0-g629fdab_master-win64.7z")
+    endif()
 else()
-    set(LOOT_API_URL "https://bintray.com/wrinklyninja/loot/download_file?file_path=loot-api_0.10.0-0-g7b97241_0.10.0.tar.xz")
+    set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.15.0/libloot.tar.xz")
 endif()
 
-ExternalProject_Add(loot-api-c++
+ExternalProject_Add(libloot
                     PREFIX "external"
-                    URL ${LOOT_API_URL}
+                    URL ${LIBLOOT_URL}
                     CONFIGURE_COMMAND ""
                     BUILD_COMMAND ""
                     INSTALL_COMMAND "")
-ExternalProject_Get_Property(loot-api-c++ SOURCE_DIR)
+ExternalProject_Get_Property(libloot SOURCE_DIR)
-set(LOOT_API_EXTRACTED_PATH ${SOURCE_DIR})
+set(LIBLOOT_EXTRACTED_PATH ${SOURCE_DIR})
 
 include_directories("${CMAKE_SOURCE_DIR}/src"
-                    "${LOOT_API_EXTRACTED_PATH}/include")
+                    "${LIBLOOT_EXTRACTED_PATH}/include")
-link_directories(${LOOT_API_EXTRACTED_PATH})
+link_directories(${LIBLOOT_EXTRACTED_PATH})
-set(LOOT_API_STATIC_LIBRARY "${CMAKE_STATIC_LIBRARY_PREFIX}loot_api${CMAKE_STATIC_LIBRARY_SUFFIX}")
+set(LIBLOOT_STATIC_LIBRARY "${CMAKE_STATIC_LIBRARY_PREFIX}loot${CMAKE_STATIC_LIBRARY_SUFFIX}")
-set(LOOT_API_SHARED_LIBRARY "${CMAKE_SHARED_LIBRARY_PREFIX}loot_api${CMAKE_SHARED_LIBRARY_SUFFIX}")
+set(LIBLOOT_SHARED_LIBRARY "${CMAKE_SHARED_LIBRARY_PREFIX}loot${CMAKE_SHARED_LIBRARY_SUFFIX}")
-
-#######################################
-# Test Masterlist
-#######################################
-
-ExternalProject_Add(test-masterlist
-                    PREFIX "external"
-                    URL "https://github.com/loot/oblivion/archive/09286601739c11a3a3e4552c6ddbdcaeffd1a8d3.zip"
-                    CONFIGURE_COMMAND ""
-                    BUILD_COMMAND ""
-                    INSTALL_COMMAND "")
 
 #######################################
 # Python Module
 #######################################
 
-pybind11_add_module(loot_api "${CMAKE_SOURCE_DIR}/src/main.cpp" "${CMAKE_BINARY_DIR}/generated/wrapper_version.cpp")
+pybind11_add_module(libloot-python  "${CMAKE_SOURCE_DIR}/src/main.cpp"
+                              "${CMAKE_SOURCE_DIR}/src/convenience.cpp"
+                              "${CMAKE_BINARY_DIR}/generated/wrapper_version.cpp")
 
-add_dependencies(loot_api loot-api-c++ test-masterlist)
+# Set the target output name to loot to follow common Python library naming
+# conventions (no lib, no -python).
+set_target_properties(libloot-python PROPERTIES OUTPUT_NAME loot)
+
+add_dependencies(libloot-python libloot)
 
 if (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    target_link_libraries(loot_api PRIVATE ${LOOT_API_STATIC_LIBRARY})
+    target_link_libraries(libloot-python PRIVATE ${LIBLOOT_STATIC_LIBRARY})
 else()
-    target_link_libraries(loot_api PRIVATE ${LOOT_API_SHARED_LIBRARY})
+    target_link_libraries(libloot-python PRIVATE ${LIBLOOT_SHARED_LIBRARY})
 endif()
 
 ########################################
@@ -100,37 +110,44 @@ endif()
 
 find_package(PythonInterp REQUIRED)
 
-# Copy the API binary to the build directory.
+# Copy the libloot binary to the build directory.
-add_custom_command(TARGET loot_api POST_BUILD
+add_custom_command(TARGET libloot-python POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "${LOOT_API_EXTRACTED_PATH}/${LOOT_API_SHARED_LIBRARY}"
+        "${LIBLOOT_EXTRACTED_PATH}/${LIBLOOT_SHARED_LIBRARY}"
-        "$<TARGET_FILE_DIR:loot_api>/${LOOT_API_SHARED_LIBRARY}")
+        "$<TARGET_FILE_DIR:libloot-python>/${LIBLOOT_SHARED_LIBRARY}")
 
-# Copy the test masterlist to the build directory.
+enable_testing()
-ExternalProject_Get_Property(test-masterlist SOURCE_DIR)
-add_custom_command(TARGET loot_api POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "${SOURCE_DIR}/masterlist.yaml"
-        "$<TARGET_FILE_DIR:loot_api>/masterlist.yaml")
 
-# Also copy the test Python script to the build directory.
+add_test(NAME python
-add_custom_command(TARGET loot_api POST_BUILD
+         WORKING_DIRECTORY $<TARGET_FILE_DIR:libloot-python>
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different
+         COMMAND "${PYTHON_EXECUTABLE}" ${CMAKE_SOURCE_DIR}/test/test.py)
-        "${CMAKE_SOURCE_DIR}/src/test.py"
-        "$<TARGET_FILE_DIR:loot_api>/test.py")
 
 ########################################
 # Install
 ########################################
 
-install(TARGETS loot_api
+install(TARGETS libloot-python
-        DESTINATION "."
+        DESTINATION "loot"
-        CONFIGURATIONS Release)
+        CONFIGURATIONS Release RelWithDebInfo)
 
-install(FILES "${LOOT_API_EXTRACTED_PATH}/${LOOT_API_SHARED_LIBRARY}"
+install(FILES "${LIBLOOT_EXTRACTED_PATH}/${LIBLOOT_SHARED_LIBRARY}"
-        "${CMAKE_SOURCE_DIR}/docs/README.md"
+        "${CMAKE_SOURCE_DIR}/python/loot/__init__.py"
+        DESTINATION "loot"
+        CONFIGURATIONS Release RelWithDebInfo)
+
+install(FILES "${CMAKE_SOURCE_DIR}/docs/README.md"
+        "${CMAKE_BINARY_DIR}/generated/setup.py"
+        "${CMAKE_SOURCE_DIR}/LICENSE"
         DESTINATION "."
-        CONFIGURATIONS Release)
+        CONFIGURATIONS Release RelWithDebInfo)
+
+IF (MSVC)
+    install(FILES $<TARGET_PDB_FILE:libloot-python>
+            DESTINATION "loot"
+            OPTIONAL
+            CONFIGURATIONS RelWithDebInfo
+            RENAME libloot-python.pdb)
+ENDIF ()
 
 ########################################
 # CPack
@@ -139,28 +156,22 @@ install(FILES "${LOOT_API_EXTRACTED_PATH}/${LOOT_API_SHARED_LIBRARY}"
 # Get version info using Git if available
 find_package(Git)
 
-IF (GIT_FOUND)
+IF (NOT DEFINED CPACK_PACKAGE_VERSION)
-    execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --long --always
+    IF (GIT_FOUND)
+        execute_process(COMMAND ${GIT_EXECUTABLE} describe --tags --long --always --abbrev=7
                     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
                     OUTPUT_VARIABLE GIT_DESCRIBE_STRING
                     OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-    IF (${GIT_DESCRIBE_STRING} MATCHES "HEAD")
+        string(REPLACE "/" "-" GIT_DESCRIBE_STRING ${GIT_DESCRIBE_STRING})
-        IF ($ENV{APPVEYOR_REPO_BRANCH})
+    ELSE()
-          set(GIT_DESCRIBE_STRING $ENV{APPVEYOR_REPO_BRANCH})
-        ENDIF()
-    ENDIF()
-ELSE()
         SET (GIT_DESCRIBE_STRING "unknown-version")
-ENDIF ()
+    ENDIF ()
 
-if (CMAKE_SYSTEM_NAME MATCHES "Windows")
+    set(CPACK_PACKAGE_VERSION "${GIT_DESCRIBE_STRING}-python$ENV{PYTHON_VERSION}")
-    set(CPACK_GENERATOR "7Z")
+ENDIF()
-else()
-    set(CPACK_GENERATOR "TXZ")
-endif()
 
-set(CPACK_PACKAGE_VERSION ${GIT_DESCRIBE_STRING})
+set(CPACK_GENERATOR "ZIP")
 set(CPACK_PACKAGE_DIRECTORY "${CMAKE_BINARY_DIR}/package")
 
 include(CPack)

README.md

@@ -1,21 +1,24 @@
-LOOT API Python Module
+libloot-python
-=======================
+==============
 
-[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/loot/loot-api-python?branch=master&svg=true)](https://ci.appveyor.com/project/WrinklyNinja/loot-api-python)
+**This repository is no longer maintained. A more complete and up to date Python wrapper can be found in the [libloot repository](https://github.com/loot/libloot/tree/aaacebefa053a6b7504bf61a73d2783a5436ca25/python).**
-[![Travis Build Status](https://travis-ci.org/loot/loot-api-python.svg?branch=master)](https://travis-ci.org/loot/loot-api-python)
+
+![CI](https://github.com/loot/libloot-python/workflows/CI/badge.svg?branch=master&event=push)
 [![Documentation Status](https://readthedocs.org/projects/loot-api-python/badge/)](http://loot-api-python.readthedocs.io/)
 
-A Python module that wraps the LOOT API, generated by [pybind11](https://github.com/pybind/pybind11).
+A Python module that wraps libloot, generated by [pybind11](https://github.com/pybind/pybind11). Not everything in the API is exposed: coverage can be extended on request (or by pull request).
 
 ## Downloads
 
-Snapshot builds are available on [Bintray](https://bintray.com/wrinklyninja/loot/loot-api-python). The snapshot build archives are named like so:
+Releases are hosted on [GitHub](https://github.com/loot/libloot-python/releases).
+
+Snapshot builds are available as artifacts from [GitHub Actions runs](https://github.com/loot/libloot-python/actions), though they are only kept for 90 days and can only be downloaded when logged into a GitHub account. The snapshot build archives are named like so:
 
 ```
-loot_api_python-<short revision ID>-win32.7z
+libloot-python-<short revision ID>-python<python version>-win<architecture>.zip
 ```
 
-For example `loot_api_python-94de368-win32.7z` was built using the revision with shortened commit ID `94de368`.
+For example `libloot-python-94de368-python3.7-win32.zip` was built using the revision with shortened commit ID `94de368`.
 
 ## Documentation
 
@@ -23,6 +26,6 @@ The documentation can be found online at [Read The Docs](http://loot-api-python.
 
 ## Build Instructions
 
-The module's build system uses [CMake](https://cmake.org/) and requires [Python](https://www.python.org) (tested with 2.7). Make sure they're installed, then run CMake, and build the generated solution file.
+The module's build system uses [CMake](https://cmake.org/) and requires [Python](https://www.python.org). Make sure they're installed, then run CMake, and build the generated solution file.
 
 Only Windows support has been tested, though Linux builds should also be possible.

appveyor.yml

@@ -1,42 +0,0 @@
-os: Visual Studio 2015
-
-version: "{build}-{branch}"
-
-configuration: Release
-
-before_build:
-  - cd %APPVEYOR_BUILD_FOLDER%
-  - ps: mkdir build
-  - cd build
-  - cmake .. -G "Visual Studio 14 2015"
-
-build:
-  verbosity: minimal
-  project: 'c:\projects\loot-api-python\build\loot_api_python.sln'
-
-test_script:
-  - cd %APPVEYOR_BUILD_FOLDER%\build\Release
-  - python -m unittest test
-
-after_test:
-  - cd %APPVEYOR_BUILD_FOLDER%\build
-  - cpack
-  # AppVeyor checks out a specific commit, but that means the archive script
-  # can't tell which branch it's on, so rename the 7z archives.
-  - ps: $env:GIT_DESCRIBE = ((git describe --tags --long --always) | Out-String) -replace "`n|`r", ""
-
-artifacts:
-  - path: build\package\loot_api_python-$(GIT_DESCRIBE)-win32.7z
-    name: loot_api_python
-
-deploy:
-  - provider: BinTray
-    username: wrinklyninja
-    api_key:
-      secure: u234T2688DZmz4JH5+0iAHcUcL2fEIGculb8655bn4B1q7GckhplsitzgEbv3NFc
-    subject: wrinklyninja
-    repo: loot
-    package: loot-api-python
-    version: $(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)
-    publish: true
-    artifact: loot_api_python

docs/README.md

@@ -1,13 +1,13 @@
-LOOT API Python Wrapper
+libloot-python
-=======================
+==============
 
-This archive contains a build of the LOOT API Python wrapper module and its corresponding 32-bit Windows build of the LOOT API.
+This archive contains a build of the libloot-python wrapper module and its corresponding 32-bit Windows build of libloot.
 
-The DLL requires the [MSVC 2015 x86 redistributable](https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe)
+The DLL requires the [MSVC 2022 x86 redistributable](https://aka.ms/vs/17/release/vc_redist.x86.exe)
 to be installed.
 
 See the [online documentation](http://loot-api-python.readthedocs.org/) for more information.
-The library source code is available [on GitHub](https://github.com/loot/loot-api-python).
+The library source code is available [on GitHub](https://github.com/loot/libloot-python).
 
 ---
 

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# LOOT API Python Module documentation build configuration file, created by
+# libloot-python documentation build configuration file, created by
 # sphinx-quickstart on Mon Aug 15 07:11:32 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -54,8 +54,8 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'LOOT API Python Module'
+project = u'libloot-python'
-copyright = u'2016, WrinklyNinja'
+copyright = u'2019, WrinklyNinja'
 author = u'WrinklyNinja'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -139,7 +139,7 @@ html_theme = 'sphinx_rtd_theme'
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'LOOT API Python Module v;atest'
+# html_title = u'libloot-python v;atest'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -265,7 +265,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'LOOTAPIPythonModule.tex', u'LOOT API Python Module Documentation',
+    (master_doc, 'libloot-python.tex', u'libloot-python Documentation',
      u'WrinklyNinja', 'manual'),
 ]
 
@@ -307,7 +307,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'lootapipythonmodule', u'LOOT API Python Module Documentation',
+    (master_doc, 'libloot-python', u'libloot-python Documentation',
      [author], 1)
 ]
 
@@ -322,8 +322,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'LOOTAPIPythonModule', u'LOOT API Python Module Documentation',
+    (master_doc, 'libloot-python', u'libloot-python Documentation',
-     author, 'LOOTAPIPythonModule', 'One line description of project.',
+     author, 'libloot-python', 'One line description of project.',
      'Miscellaneous'),
 ]
 
@@ -346,5 +346,5 @@ texinfo_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'loot_api': ('http://loot.readthedocs.io/en/0.10.0/', None),
+    'loot_api': ('http://loot.readthedocs.io/en/0.14.7/', None),
 }

docs/index.rst

@@ -1,10 +1,10 @@
-.. LOOT API Python Module documentation master file, created by
+.. libloot-python documentation master file, created by
    sphinx-quickstart on Mon Aug 15 07:11:32 2016.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-LOOT API Python Module
+libloot-python
-======================
+==============
 
 Contents:
 

docs/reference.rst

@@ -2,8 +2,8 @@
 API Reference
 *************
 
-As this API is just a wrapper for LOOT's C++ API, its documentation is linked to
+As this API is just a wrapper for libloot's C++ API, its documentation is linked
-for all non-Python-specific information.
+to for all non-Python-specific information.
 
 Enumerations
 ============
@@ -12,10 +12,9 @@ The wrapped enumeration types below are classes in Python, but the distinction
 makes no difference in practice, so they're grouped here for semantics. All
 values are unsigned integer constants.
 
-.. py:class:: loot_api.GameType
+.. py:class:: loot.GameType
 
-  Wraps :cpp:type:`loot::GameType` to expose the LOOT API's game
+  Wraps :cpp:type:`loot::GameType` to expose libloot's game codes.
-  codes.
 
   .. py:attribute:: fo3
   .. py:attribute:: fo4
@@ -24,47 +23,54 @@ values are unsigned integer constants.
   .. py:attribute:: tes5
   .. py:attribute:: tes5se
 
-.. py:class:: loot_api.LanguageCode
+.. py:class:: loot.LogLevel
 
-  Wraps :cpp:type:`loot::LanguageCode` to expose the LOOT API's
+  Wraps :cpp:type:`loot::LogLevel` to expose libloot's log level codes.
-  language codes.
 
-  .. py:attribute:: english
+  .. py:attribute:: trace
-  .. py:attribute:: spanish
+  .. py:attribute:: debug
-  .. py:attribute:: russian
+  .. py:attribute:: info
-  .. py:attribute:: french
+  .. py:attribute:: warning
-  .. py:attribute:: chinese
+  .. py:attribute:: error
-  .. py:attribute:: polish
+  .. py:attribute:: fatal
-  .. py:attribute:: brazilian_portuguese
-  .. py:attribute:: finnish
-  .. py:attribute:: german
-  .. py:attribute:: danish
-  .. py:attribute:: korean
 
-.. py:class:: loot_api.MessageType
+.. py:class:: loot.MessageType
 
-  Wraps :cpp:type:`loot::MessageType` to expose the LOOT API's
+  Wraps :cpp:type:`loot::MessageType` to expose libloot's message type
-  message type codes.
+  codes.
 
   .. py:attribute:: error
   .. py:attribute:: say
   .. py:attribute:: warn
 
-.. py:class:: loot_api.PluginCleanliness
+.. py:class:: loot.PluginCleanliness
 
-  Wraps :cpp:type:`loot::PluginCleanliness` to expose the LOOT API's plugin cleanliness state codes.
+  Codes used to indicate the cleanliness of a plugin according to the
+  information contained within the loaded masterlist/userlist.
 
   .. py:attribute:: clean
+
+    Indicates that the plugin is clean.
+
   .. py:attribute:: dirty
+
+    Indicates that the plugin is dirty.
+
   .. py:attribute:: do_not_clean
+
+    Indicates that the plugin contains dirty edits, but that they are part of
+    the plugin’s intended functionality and should not be removed.
+
   .. py:attribute:: unknown
 
+    Indicates that no data is available on whether the plugin is dirty or not.
+
 Public-Field Data Structures
 ============================
 
 Classes with public fields and no member functions.
 
-.. py:class:: loot_api.MasterlistInfo
+.. py:class:: loot.MasterlistInfo
 
   Wraps :cpp:class:`loot::MasterlistInfo`.
 
@@ -81,23 +87,27 @@ Classes with public fields and no member functions.
     A boolean that is true if the masterlist has been modified from its state
     at the commit given by :py:attr:`revision_id`.
 
-.. py:class:: loot_api.Message
+.. py:class:: loot.SimpleMessage
 
   Wraps :cpp:class:`loot::SimpleMessage`.
 
   .. py:attribute:: type
 
-    A :py:class:`loot_api.MessageType` giving the message type.
+    A :py:class:`loot.MessageType` giving the message type.
 
   .. py:attribute:: language
 
-    A :py:class:`loot_api.LanguageCode` giving the message text language.
+    A Unicode string giving the message text language.
 
   .. py:attribute:: text
 
     A Unicode string containing the message text.
 
-.. py:class:: loot_api.PluginTags
+  .. py:attribute:: condition
+
+    A Unicode string containing the message condition.
+
+.. py:class:: loot.PluginTags
 
   Wraps :cpp:class:`loot::PluginTags`.
 
@@ -117,58 +127,68 @@ Classes with public fields and no member functions.
 Functions
 =========
 
-.. py:function:: loot_api.is_compatible(int, int, int) -> bool
+.. py:function:: loot.set_logging_callback(callback) -> NoneType
+
+  Set the callback function that is called when logging. Wraps
+  :cpp:func:`loot::SetLoggingCallback`.
+
+.. py:function:: loot.is_compatible(int, int, int) -> bool
 
   Checks for API compatibility. Wraps :cpp:func:`loot::IsCompatible`.
 
-.. py:function:: loot_api.create_database(game : loot_api.GameType, [game_path : unicode = u'', [game_local_path : unicode = u'']]) -> loot_api.DatabaseInterface
+.. py:function:: loot.create_game_handle(game : loot.GameType, game_path : unicode, [game_local_path : unicode = u'']) -> loot.GameInterface
 
-  Initialise a new database handle. Wraps :cpp:func:`loot::IsCompatible`.
+  Initialise a new game handle. Wraps :cpp:func:`loot::CreateGameHandle`.
 
 Classes
 =======
 
-.. py:class:: loot_api.DatabaseInterface
+.. py:class:: loot.GameInterface
+
+  Wraps :cpp:class:`loot::GameInterface`.
+
+  .. py:function:: loot.get_database() -> loot.DatabaseInterface
+
+    Get a database handle. Wraps :cpp:func:`loot::GetDatabase`.
+
+  .. py:function:: loot.load_current_load_order_state() -> NoneType
+
+    Load the current load order state, discarding any previously held state.
+    Wraps :cpp:func:`loot::LoadCurrentLoadOrderState`.
+
+.. py:class:: loot.DatabaseInterface
 
   Wraps :cpp:class:`loot::DatabaseInterface`.
 
-  .. py:method:: eval_lists(loot_api.DatabaseInterface) -> NoneType
+  .. py:method:: get_masterlist_revision(loot.DatabaseInterface, unicode, bool) -> loot.MasterlistInfo
-
-    Evaluates all conditions and regular expression metadata entries in the loaded metadata lists. Wraps :cpp:func:`EvalLists`.
-
-  .. py:method:: get_masterlist_revision(loot_api.DatabaseInterface, unicode, bool) -> loot_api.MasterlistInfo
 
     Gets the give masterlist’s source control revision. Wraps :cpp:func:`GetMasterlistRevision`.
 
-  .. py:method:: get_plugin_cleanliness(loot_api.DatabaseInterface, unicode) -> loot_api.PluginCleanliness
+  .. py:method:: get_plugin_metadata(loot.DatabaseInterface, plugin : unicode, [includeUserMetadata : bool = True, [evaluateConditions : bool = False]]) -> loot.PluginMetadata
 
-    Determines the database’s knowledge of a plugin’s cleanliness. Wraps :cpp:func:`GetPluginCleanliness`.
+    Get all a plugin’s loaded metadata. Wraps :cpp:func:`GetPluginMetadata`.
 
-  .. py:method:: get_plugin_messages(loot_api.DatabaseInterface, unicode, loot_api.LanguageCode) -> list<loot_api.Message>
+  .. py:method:: get_plugin_cleanliness(loot.DatabaseInterface, plugin : unicode, [evaluateConditions : bool = False]) -> loot.PluginCleanliness
 
-    Outputs the messages associated with the given plugin in the database. Wraps :cpp:func:`GetPluginMessages`.
+    Determines the database’s knowledge of a plugin’s cleanliness. Outputs whether the plugin should be cleaned or not, or if no data is available.
 
-  .. py:method:: get_plugin_tags(loot_api.DatabaseInterface, unicode) -> loot_api.PluginTags
+  .. py:method:: get_plugin_tags(loot.DatabaseInterface, plugin : unicode, [evaluateConditions : bool = False]) -> loot.PluginTags
 
-    Outputs the Bash Tags suggested for addition and removal by the database for the given plugin. Wraps :cpp:func:`GetPluginTags`.
+    Outputs the Bash Tags suggested for addition and removal by the database for the given plugin.
 
-  .. py:method:: load_lists(loot_api.DatabaseInterface, masterlist_path : unicode, [userlist_path : unicode = u'']) -> NoneType
+  .. py:method:: load_lists(loot.DatabaseInterface, masterlist_path : unicode, [userlist_path : unicode = u'']) -> NoneType
 
     Loads the masterlist and userlist from the paths specified. Wraps :cpp:func:`LoadLists`.
 
-  .. py:method:: sort_plugins(loot_api.DatabaseInterface, list<unicode>) -> list<unicode>
+  .. py:method:: update_masterlist(loot.DatabaseInterface, unicode, unicode, unicode) -> bool
-
-    Calculates a new load order for all a game’s installed plugins and outputs the sorted order. Wraps :cpp:func:`SortPlugins`.
-
-  .. py:method:: update_masterlist(loot_api.DatabaseInterface, unicode, unicode, unicode) -> bool
 
     Updates the given masterlist using the given Git repository details. Wraps :cpp:func:`UpdateMasterlist`.
 
-  .. py:method:: write_minimal_list(loot_api.DatabaseInterface, unicode, bool) -> NoneType
+  .. py:method:: write_minimal_list(loot.DatabaseInterface, unicode, bool) -> NoneType
 
     Writes a minimal metadata file containing only Bash Tag suggestions and/or cleanliness info from the loaded metadata. Wraps :cpp:func:`WriteMinimalList`.
 
-.. py:class:: loot_api.Version
+.. py:class:: loot.Version
 
   Wraps :cpp:class:`loot::LootVersion`.
 
@@ -192,10 +212,9 @@ Classes
 
     Returns the API version as a string of the form ``major.minor.patch``
 
-.. py:class:: loot_api.WrapperVersion
+.. py:class:: loot.WrapperVersion
 
-  Provides information about the version of the LOOT API Python wrapper that is
+  Provides information about the version of libloot-python that is being run.
-  being run.
 
   .. py:attribute:: major
 
@@ -216,3 +235,12 @@ Classes
   .. py:staticmethod:: string() -> unicode
 
     Returns the API version as a string of the form ``major.minor.patch``
+
+.. py:class:: loot.PluginMetadata
+
+  Wraps :cpp:class:`loot::PluginMetadata`.
+
+  .. py:method:: get_simple_messages(loot.PluginMetadata, unicode) -> list<loot.SimpleMessage>
+
+    Get the plugin’s messages as SimpleMessage objects for the given language.
+    Wraps :cpp:func:`GetPluginMessages`.

docs/usage.rst

@@ -7,16 +7,16 @@ Installing the wrapper
 
 Build archives contain two binaries:
 
-* ``loot_api.pyd`` is the Python wrapper
+* ``loot.*.pyd`` is the Python wrapper
-* ``loot_api.dll`` is the C++ API DLL that the Python wrapper was built against.
+* ``loot.dll`` is the C++ library DLL that the Python wrapper was built against.
 
-The C++ DLL requires the `Visual C++ 2015 Redistributable (x86)`_
+The C++ DLL requires the `Visual C++ 2022 Redistributable (x86)`_
 to be installed.
 
 To use the wrapper, copy both files to wherever you want to import them from
 (they must be in the same folder), and you're done!
 
-.. _Visual C++ 2015 Redistributable (x86): https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe
+.. _Visual C++ 2022 Redistributable (x86): https://aka.ms/vs/17/release/vc_redist.x86.exe
 
 Using the wrapper
 =================
@@ -27,10 +27,10 @@ Checking Compatibility
 To check if the module loaded is compatible with the version of the API that you
 developed against::
 
-  >>> import loot_api
+  >>> import loot
-  >>> loot_api.is_compatible(0,10,0)
+  >>> loot.is_compatible(0,14,0)
   True
-  >>> loot_api.is_compatible(0,9,0)
+  >>> loot.is_compatible(0,9,0)
   False
 
 Getting a Plugin's Bash Tag Suggestions
@@ -38,9 +38,9 @@ Getting a Plugin's Bash Tag Suggestions
 
 To get a plugin's Bash Tag suggestions from a ``masterlist.yaml`` metadata file::
 
-  >>> import loot_api
+  >>> import loot
-  >>> db = loot_api.create_database(loot_api.GameType.tes4, '', '')
+  >>> db = loot.create_game_handle(loot.GameType.tes4, 'C:\\path\\to\\oblivion\\directory')
-  >>> db.load_lists('masterlist.yaml', '')
+  >>> db.load_lists('masterlist.yaml')
   >>> tags = db.get_plugin_tags(u'Unofficial Oblivion Patch.esp')
   >>> tags.added
   set([u'Scripts', u'Relations', u'C.Owner', u'Actors.AIPackages', u'Actors.Stats', u'Actors.ACBS', u'C.Music', u'Factions', u'Invent', u'Relev', u'Names', u'C.Light', u'Delev', u'C.Name', u'C.Climate', u'NPC.Class', u'Stats', u'Actors.DeathItem', u'Creatures.Blood', u'Actors.CombatStyle', u'Actors.AIData'])

python/loot/__init__.py

@@ -0,0 +1 @@
+from .loot import *

python/setup.py

@@ -0,0 +1,88 @@
+import itertools
+import os
+import platform
+import subprocess
+import sys
+import tempfile
+import threading
+import time
+from contextlib import contextmanager
+
+from setuptools import Distribution, find_packages, setup
+
+try:  # python 3
+    import winreg
+    from urllib.request import urlretrieve
+except ImportError:  # python 2
+    import _winreg as winreg
+    from urllib import urlretrieve
+
+
+MSVC_MIN_VERSION = (14, 0, 24215)
+
+
+class BinaryDistribution(Distribution):
+    def has_ext_modules(foo):
+        return True
+
+
+def is_msvc_redist_installed(major, minor, build):
+    if platform.machine().endswith("64"):  # check if os is 64bit
+        sub_key = "SOFTWARE\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\x64"
+    else:
+        sub_key = "SOFTWARE\\Microsoft\\VisualStudio\\14.0\\VC\\Runtimes\\x86"
+    try:
+        key_handle = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, sub_key)
+        runtime_installed = winreg.QueryValueEx(key_handle, "Installed")[0]
+        installed_major = winreg.QueryValueEx(key_handle, "Major")[0]
+        installed_minor = winreg.QueryValueEx(key_handle, "Minor")[0]
+        installed_build = winreg.QueryValueEx(key_handle, "Bld")[0]
+        return (
+            runtime_installed != 0
+            and installed_major >= major
+            and installed_minor >= minor
+            and installed_build >= build
+        )
+    except WindowsError as exc:
+        return False
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+def install_msvc_redist():
+    url = (
+        "https://download.microsoft.com/download/6/A/A/"
+        "6AA4EDFF-645B-48C5-81CC-ED5963AEAD48/vc_redist.x86.exe"
+    )
+    dl_dir = tempfile.mkdtemp()
+    dl_file = os.path.join(dl_dir, "vc_redist.exe")
+    urlretrieve(url, dl_file)
+    subprocess.call([dl_file, "/quiet"])
+    # trying to remove the temp folder triggers
+    # an error during py2 pip install
+
+
+if not is_msvc_redist_installed(*MSVC_MIN_VERSION):
+    install_msvc_redist()
+
+# The version string is substituted in by CMake.
+setup(
+    name="libloot-python",
+    version="@LIBLOOT_PY_VERSION_MAJOR@.@LIBLOOT_PY_VERSION_MINOR@.@LIBLOOT_PY_VERSION_PATCH@",
+    description="A Python module that wraps libloot.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/loot/libloot-python",
+    packages=find_packages(),
+    include_package_data=True,
+    package_data={"loot": ["loot*.pyd", "loot.dll"]},
+    distclass=BinaryDistribution,
+    classifiers=[
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: C++'
+        'Operating System :: Microsoft :: Windows',
+        'Intended Audience :: Developers',
+    ],
+    python_requires='>=3.7',
+)

scripts/travis/loot-api.bintray.json

@@ -1,15 +0,0 @@
-{
-  "package": {
-    "name": "loot-api-python",
-    "repo": "loot",
-    "subject": "wrinklyninja"
-  },
-  "version": {
-    "name": "REPLACE_THIS_VERSION"
-  },
-  "files": [{
-    "includePattern": "build/package/(loot_api_python-.+\\.tar.xz)",
-    "uploadPattern": "$1"
-  }],
-  "publish": true
-}

src/convenience.cpp

@@ -0,0 +1,83 @@
+/*  LOOT
+
+A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+Fallout: New Vegas.
+
+Copyright (C) 2014-2017    Oliver Hamlet
+
+This file is part of LOOT.
+
+LOOT is free software: you can redistribute
+it and/or modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+LOOT is distributed in the hope that it will
+be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with LOOT.  If not, see
+<https://www.gnu.org/licenses/>.
+*/
+
+#include "convenience.h"
+
+#include <loot/api.h>
+
+namespace loot {
+PluginTags GetPluginTags(const std::shared_ptr<DatabaseInterface> db, const std::string& plugin, bool evaluateConditions) {
+  PluginTags tags;
+
+  auto metadata = db->GetPluginMetadata(plugin, false, evaluateConditions);
+  if (metadata.has_value()) {
+    for (const auto &tag : metadata.value().GetTags()) {
+      if (tag.IsAddition())
+        tags.added.insert(tag.GetName());
+      else
+        tags.removed.insert(tag.GetName());
+    }
+  }
+
+  metadata = db->GetPluginUserMetadata(plugin, evaluateConditions);
+  if (metadata.has_value()) {
+    tags.userlist_modified = !metadata.value().GetTags().empty();
+    for (const auto &tag : metadata.value().GetTags()) {
+      if (tag.IsAddition())
+        tags.added.insert(tag.GetName());
+      else
+        tags.removed.insert(tag.GetName());
+    }
+  }
+
+  return tags;
+}
+
+PluginCleanliness GetPluginCleanliness(const std::shared_ptr<DatabaseInterface> db, const std::string& plugin, bool evaluateConditions) {
+  auto metadata = db->GetPluginMetadata(plugin, true, evaluateConditions);
+
+  if (!metadata.has_value()) {
+    return PluginCleanliness::unknown;
+  }
+
+  auto dirtyInfo = metadata.value().GetDirtyInfo();
+  auto cleanInfo = metadata.value().GetCleanInfo();
+
+  if (dirtyInfo.empty() == cleanInfo.empty()) {
+    return PluginCleanliness::unknown;
+  }
+
+  if (!cleanInfo.empty()) {
+    return PluginCleanliness::clean;
+  }
+
+  for (const auto& info : dirtyInfo) {
+    if (info.ChooseInfo("en").GetText().find("Do not clean") != std::string::npos) {
+      return PluginCleanliness::do_not_clean;
+    }
+  }
+
+  return PluginCleanliness::dirty;
+}
+}

src/convenience.h

@@ -0,0 +1,46 @@
+/*  LOOT
+
+A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+Fallout: New Vegas.
+
+Copyright (C) 2014-2017    Oliver Hamlet
+
+This file is part of LOOT.
+
+LOOT is free software: you can redistribute
+it and/or modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+LOOT is distributed in the hope that it will
+be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with LOOT.  If not, see
+<https://www.gnu.org/licenses/>.
+*/
+
+#ifndef LIBLOOT_PYTHON_CONVENIENCE
+#define LIBLOOT_PYTHON_CONVENIENCE
+
+#include <memory>
+
+#include <loot/enum/game_type.h>
+#include <loot/database_interface.h>
+
+#include "plugin_cleanliness.h"
+#include "plugin_tags.h"
+
+namespace loot {
+PluginTags GetPluginTags(const std::shared_ptr<DatabaseInterface> db,
+                         const std::string& plugin,
+                         bool evaluateConditions = false);
+
+PluginCleanliness GetPluginCleanliness(const std::shared_ptr<DatabaseInterface> db,
+                                       const std::string& plugin,
+                                       bool evaluateConditions = false);
+}
+
+#endif

src/main.cpp

@@ -25,53 +25,59 @@
 #include <loot/api.h>
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
+#include <pybind11/functional.h>
 
+#include "convenience.h"
 #include "wrapper_version.h"
 
-PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>);
+using pybind11::arg;
+using pybind11::enum_;
+using pybind11::class_;
+using pybind11::metaclass;
+using std::filesystem::path;
+using std::filesystem::u8path;
 
-PYBIND11_PLUGIN(loot_api) {
+namespace loot {
-  using loot::CreateDatabase;
+namespace py {
-  using loot::DatabaseInterface;
+std::shared_ptr<GameInterface> CreateGameHandle(GameType gameType, std::string gamePath, std::string gameLocalPath) {
-  using loot::IsCompatible;
+  return CreateGameHandle(gameType, u8path(gamePath), u8path(gameLocalPath));
-  using loot::GameType;
+}
-  using loot::LanguageCode;
-  using loot::LootVersion;
-  using loot::MessageType;
-  using loot::MasterlistInfo;
-  using loot::PluginCleanliness;
-  using loot::SimpleMessage;
-  using loot::PluginTags;
-  using loot::WrapperVersion;
 
-  using pybind11::arg;
+void LoadLists(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, std::string userlistPath) {
-  using pybind11::enum_;
+  return db->LoadLists(u8path(masterlistPath), u8path(userlistPath));
-  using pybind11::class_;
+}
 
-  const std::string emptyString;
+void WriteMinimalList(std::shared_ptr<DatabaseInterface> db, std::string outputFile, bool overwrite) {
+  return db->WriteMinimalList(u8path(outputFile), overwrite);
+}
 
-  pybind11::module module("loot_api", "A Python module that wraps the LOOT API, generated by pybind11.");
+bool UpdateMasterlist(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, std::string remoteUrl, std::string remoteBranch) {
+  return db->UpdateMasterlist(u8path(masterlistPath), remoteUrl, remoteBranch);
+}
 
+MasterlistInfo GetMasterlistRevision(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, bool getShortId) {
+  return db->GetMasterlistRevision(u8path(masterlistPath), getShortId);
+}
+}
+
+void bindEnums(pybind11::module& module) {
   enum_<GameType>(module, "GameType")
     .value("tes4", GameType::tes4)
     .value("tes5", GameType::tes5)
     .value("tes5se", GameType::tes5se)
+    .value("tes5vr", GameType::tes5vr)
     .value("fo3", GameType::fo3)
     .value("fonv", GameType::fonv)
-    .value("fo4", GameType::fo4);
+    .value("fo4", GameType::fo4)
+    .value("fo4vr", GameType::fo4vr);
 
-  enum_<LanguageCode>(module, "LanguageCode")
+  enum_<LogLevel>(module, "LogLevel")
-    .value("english", LanguageCode::english)
+    .value("trace", LogLevel::trace)
-    .value("spanish", LanguageCode::spanish)
+    .value("debug", LogLevel::debug)
-    .value("russian", LanguageCode::russian)
+    .value("info", LogLevel::info)
-    .value("french", LanguageCode::french)
+    .value("warning", LogLevel::warning)
-    .value("chinese", LanguageCode::chinese)
+    .value("error", LogLevel::error)
-    .value("polish", LanguageCode::polish)
+    .value("fatal", LogLevel::fatal);
-    .value("brazilian_portuguese", LanguageCode::brazilian_portuguese)
-    .value("finnish", LanguageCode::finnish)
-    .value("german", LanguageCode::german)
-    .value("danish", LanguageCode::danish)
-    .value("korean", LanguageCode::korean);
 
   enum_<MessageType>(module, "MessageType")
     .value("say", MessageType::say)
@@ -83,28 +89,36 @@ PYBIND11_PLUGIN(loot_api) {
     .value("dirty", PluginCleanliness::dirty)
     .value("do_not_clean", PluginCleanliness::do_not_clean)
     .value("unknown", PluginCleanliness::unknown);
+}
 
+void bindMetadataClasses(pybind11::module& module) {
   class_<MasterlistInfo>(module, "MasterlistInfo")
     .def_readwrite("revision_id", &MasterlistInfo::revision_id)
     .def_readwrite("revision_date", &MasterlistInfo::revision_date)
     .def_readwrite("is_modified", &MasterlistInfo::is_modified);
 
-  class_<SimpleMessage>(module, "Message")
+  class_<SimpleMessage>(module, "SimpleMessage")
     .def_readwrite("type", &SimpleMessage::type)
     .def_readwrite("language", &SimpleMessage::language)
-    .def_readwrite("text", &SimpleMessage::text);
+    .def_readwrite("text", &SimpleMessage::text)
+    .def_readwrite("condition", &SimpleMessage::condition);
 
   class_<PluginTags>(module, "PluginTags")
     .def_readwrite("added", &PluginTags::added)
     .def_readwrite("removed", &PluginTags::removed)
     .def_readwrite("userlist_modified", &PluginTags::userlist_modified);
 
+  class_<PluginMetadata>(module, "PluginMetadata")
+    .def("get_simple_messages", &PluginMetadata::GetSimpleMessages);
+}
+
+void bindVersionClasses(pybind11::module& module) {
   class_<LootVersion>(module, "Version")
     .def_readonly_static("major", &LootVersion::major)
     .def_readonly_static("minor", &LootVersion::minor)
     .def_readonly_static("patch", &LootVersion::patch)
     .def_readonly_static("revision", &LootVersion::revision)
-    .def_static("string", LootVersion::string);
+    .def_static("string", LootVersion::GetVersionString);
 
   class_<WrapperVersion>(module, "WrapperVersion")
     .def_readonly_static("major", &WrapperVersion::major)
@@ -112,21 +126,59 @@ PYBIND11_PLUGIN(loot_api) {
     .def_readonly_static("patch", &WrapperVersion::patch)
     .def_readonly_static("revision", &WrapperVersion::revision)
     .def_static("string", WrapperVersion::string);
+}
+
+void bindInterfaceClasses(pybind11::module& module) {
+  class_<GameInterface, std::shared_ptr<GameInterface>>(module, "GameInterface")
+    .def("load_current_load_order_state", &GameInterface::LoadCurrentLoadOrderState)
+    .def("get_database", &GameInterface::GetDatabase);
 
   class_<DatabaseInterface, std::shared_ptr<DatabaseInterface>>(module, "DatabaseInterface")
-    .def("load_lists", &DatabaseInterface::LoadLists, arg("masterlist_path"), arg("userlist_path") = emptyString)
+    .def("load_lists", &py::LoadLists, arg("masterlist_path"), arg("userlist_path") = "")
-    .def("eval_lists", &DatabaseInterface::EvalLists)
+    .def("update_masterlist", &py::UpdateMasterlist)
-    .def("sort_plugins", &DatabaseInterface::SortPlugins)
+    .def("get_masterlist_revision", &py::GetMasterlistRevision)
-    .def("update_masterlist", &DatabaseInterface::UpdateMasterlist)
+    .def("get_plugin_metadata", &DatabaseInterface::GetPluginMetadata,
-    .def("get_masterlist_revision", &DatabaseInterface::GetMasterlistRevision)
+      arg("plugin"),
-    .def("get_plugin_tags", &DatabaseInterface::GetPluginTags)
+      arg("includeUserMetadata") = true,
-    .def("get_plugin_messages", &DatabaseInterface::GetPluginMessages)
+      arg("evaluateConditions") = false)
-    .def("get_plugin_cleanliness", &DatabaseInterface::GetPluginCleanliness)
+    .def("get_plugin_tags", &GetPluginTags,
-    .def("write_minimal_list", &DatabaseInterface::WriteMinimalList);
+      arg("plugin"),
+      arg("evaluateConditions") = false)
+    .def("get_plugin_cleanliness", &GetPluginCleanliness,
+      arg("plugin"),
+      arg("evaluateConditions") = false)
+    .def("write_minimal_list", &py::WriteMinimalList);
+}
+
+void bindClasses(pybind11::module& module) {
+  bindMetadataClasses(module);
+  bindVersionClasses(module);
+  bindInterfaceClasses(module);
+}
+
+void bindFunctions(pybind11::module& module) {
+  module.def("set_logging_callback", &SetLoggingCallback);
+
+  // Need to clear the stored logging callback when exiting, or Python will
+  // hang because the callback pointer is still stored by libloot.
+  auto atexit = pybind11::module::import("atexit");
+  atexit.attr("register")(pybind11::cpp_function([]() {
+    SetLoggingCallback(nullptr);
+  }));
 
   module.def("is_compatible", &IsCompatible);
 
-  module.def("create_database", &CreateDatabase, arg("game"), arg("game_path") = emptyString, arg("game_local_path") = emptyString);
+  module.def("create_game_handle", &py::CreateGameHandle,
+    arg("game"),
+    arg("game_path"),
+    arg("game_local_path") = "");
+}
+}
 
-  return module.ptr();
+PYBIND11_MODULE(loot, module) {
+  module.doc() = "A Python module that wraps libloot, generated by pybind11.";
+
+  loot::bindEnums(module);
+  loot::bindClasses(module);
+  loot::bindFunctions(module);
 }

src/plugin_cleanliness.h

@@ -0,0 +1,52 @@
+/*  LOOT
+
+    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+    Fallout: New Vegas.
+
+    Copyright (C) 2012-2016    WrinklyNinja
+
+    This file is part of LOOT.
+
+    LOOT is free software: you can redistribute
+    it and/or modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    LOOT is distributed in the hope that it will
+    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with LOOT.  If not, see
+    <https://www.gnu.org/licenses/>.
+    */
+#ifndef LIBLOOT_PYTHON_PLUGIN_CLEANLINESS
+#define LIBLOOT_PYTHON_PLUGIN_CLEANLINESS
+
+/**
+ * The namespace used by libloot.
+ */
+namespace loot {
+/**
+ * @brief Codes used to indicate the cleanliness of a plugin according to the
+ *        information contained within the loaded masterlist/userlist.
+ */
+enum struct PluginCleanliness : unsigned int {
+  /** Indicates that the plugin is clean. */
+  clean,
+  /** Indicates that the plugin is dirty. */
+  dirty,
+  /**
+   * Indicates that the plugin contains dirty edits, but that they are
+   * part of the plugin's intended functionality and should not be removed.
+   */
+  do_not_clean,
+  /**
+   * Indicates that no data is available on whether the plugin is dirty or not.
+   */
+  unknown,
+};
+}
+
+#endif

src/plugin_tags.h

@@ -0,0 +1,58 @@
+/*  LOOT
+
+    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+    Fallout: New Vegas.
+
+    Copyright (C) 2012-2016    WrinklyNinja
+
+    This file is part of LOOT.
+
+    LOOT is free software: you can redistribute
+    it and/or modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    LOOT is distributed in the hope that it will
+    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with LOOT.  If not, see
+    <https://www.gnu.org/licenses/>.
+    */
+#ifndef LIBLOOT_PYTHON_PLUGIN_TAGS
+#define LIBLOOT_PYTHON_PLUGIN_TAGS
+
+#include <set>
+#include <string>
+
+namespace loot {
+/**
+ * @brief A structure that holds data about the Bash Tag suggestions made by
+ *        LOOT for a plugin.
+ */
+struct PluginTags {
+  inline PluginTags() : userlist_modified(false) {}
+
+  /**
+   * @brief A set of Bash Tag names suggested for addition to the specified
+   *        plugin. Empty if no Bash Tag additions are suggested.
+   */
+  std::set<std::string> added;
+
+  /**
+   * @brief A set of Bash Tag names suggested for removal from the specified
+   *        plugin. Empty if no Bash Tag removals are suggested.
+   */
+  std::set<std::string> removed;
+
+  /**
+  * @brief `true` if the Bash Tag suggestions were modified by data in the
+  *        userlist, `false` otherwise.
+  */
+  bool userlist_modified;
+};
+}
+
+#endif