Skip to main content

The Elder Scrolls Files Reader

A reader for The Elder Scrolls files.

Minimal Example - Print the Number of Books

import os
from tes_reader import ElderScrollsFileReader

game_folder = 'C:\\Program Files (x86)\\Steam\\steamapps\\common\\Skyrim Special Edition\\'

game_file_path = os.path.join(game_folder, 'Data', 'Skyrim.esm')

with ElderScrollsFileReader(game_file_path) as elder_scrolls_file:
    book_count = len(elder_scrolls_file['BOOK'])
    print(f"Skyrim.esm has {book_count} books in it.")

See the GitHub page for more examples.

Installation

pip install tes-reader

Requirements

  • Python 3.5+
  • pip (Package manager for Python)
  • Windows
  • An Elder Scrolls Game - for example, Skyrim.

Support and Future Development

Currently, I do not have any plans. I have a few example scripts that I have used myself, I can add them from time to time. I could also containerize the tests to make it easier to run them.

Development and Testing

Clone from github using git clone git@github.com:sinan-ozel/tes-reader.git

Install the requirements for development using the command pip install -r requirements/dev.txt. I personally prefer using a virtualenv to keep modules organized.

To run the tests, you will need computer with Skyrim installed. Go into the tests folder. Set the configuration in the test.ini file to point to the Skyrim's executable folder (not the data folder). Finally, run the command py.test -v, while inside the tests folder.

Metadata

Release files for tes-reader 0.1.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 tes-reader 0.1.1
File Size Uploaded Provenance Actions
tes-reader-0.1.1.tar.gz 10.2 kB Without provenance Details for tes-reader-0.1.1.tar.gz

Release files / tes-reader-0.1.1.tar.gz

Download URL tes-reader-0.1.1.tar.gz
Size 10.2 kB
Tags Source
SHA-256 checksum
How to use checksums
2557a2cc765868452a4230796830df233578782e50a55c854668df59de3715bb
BLAKE2b-256 checksum
How to use checksums
2fd42c37ef5642df5b36bbecce05e8e36a3cd35ba5c81a7515afa465d5e4f273
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

Security for tes-reader 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page