README.md

libloot-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 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

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:

```
libloot-python-<short revision ID>-python<python version>-win<architecture>.zip
```

For example `libloot-python-94de368-python3.7-win32.zip` was built using the revision with shortened commit ID `94de368`.

## Documentation

The documentation can be found online at [Read The Docs](http://loot-api-python.readthedocs.org/).

## Build Instructions

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.
Rename package and repository to libloot-python and module to loot 2019-10-22 21:02:15 +01:00			`libloot-python`
			`==============`
Initial commit of module generator code 2016-08-07 21:23:23 +01:00
Migrate CI to GitHub Actions 2021-02-14 13:07:59 +00:00			`![CI](https://github.com/loot/libloot-python/workflows/CI/badge.svg?branch=master&event=push)`
Start to document API 2016-08-15 20:51:24 +01:00			`[![Documentation Status](https://readthedocs.org/projects/loot-api-python/badge/)](http://loot-api-python.readthedocs.io/)`
Update readme 2016-08-13 15:00:01 +01:00
Update readme 2018-12-13 17:46:21 +00:00			`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).`
Initial commit of module generator code 2016-08-07 21:23:23 +01:00
Update readme 2016-08-13 15:00:01 +01:00			`## Downloads`

Stop uploading snapshot artifacts to Artifactory 2023-06-05 17:34:29 +01:00			`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:`
Update readme 2016-08-13 15:00:01 +01:00
			```
Rename package and repository to libloot-python and module to loot 2019-10-22 21:02:15 +01:00			`libloot-python-<short revision ID>-python<python version>-win<architecture>.zip`
Update readme 2016-08-13 15:00:01 +01:00			```

Drop support for Python 2.7 2022-07-02 16:36:14 +01:00			For example `libloot-python-94de368-python3.7-win32.zip` was built using the revision with shortened commit ID `94de368`.
Update readme 2016-08-13 15:00:01 +01:00
Start to document API 2016-08-15 20:51:24 +01:00			`## Documentation`

			`The documentation can be found online at [Read The Docs](http://loot-api-python.readthedocs.org/).`
Update readme 2016-08-13 15:00:01 +01:00
Initial commit of module generator code 2016-08-07 21:23:23 +01:00			`## Build Instructions`

Update readme 2018-12-13 17:46:21 +00:00			`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.`
Initial commit of module generator code 2016-08-07 21:23:23 +01:00
			`Only Windows support has been tested, though Linux builds should also be possible.`