Skip to content

Using TaleSpire Encoding in Your Own Project

Jump to bottom
Baldrax edited this page May 26, 2026 · 1 revision

talespire-encoding is distributed as a normal Python package through PyPI talespire-encoding.

If you are building your own TaleSpire tools, applications, or pipelines, it is strongly recommended that you install the package dynamically rather than copying the source code directly into your project.

Why Use the Package Instead of Copying the Source?

Using the published package has several advantages:

  • Easier updates
  • Cleaner dependency management
  • Bug fixes and improvements automatically available
  • Clear versioning and compatibility
  • Avoids maintaining local modified copies
  • Keeps projects smaller and easier to maintain

Instead of vendoring the library into your repository, depend on the published package like any other Python dependency.

Installation

Install the latest release:

pip install talespire-encoding

Install a specific version:

pip install talespire-encoding==1.2.3

Upgrade to the latest release:

pip install --upgrade talespire-encoding

Adding the Dependency to Your Project

pyproject.toml

Recommended for modern Python projects:

[project]
dependencies = [
    "talespire-encoding>=1.2.3"
]

Or pin to a specific tested version:

[project]
dependencies = [
    "talespire-encoding==1.2.3"
]

requirements.txt

talespire-encoding>=1.2.3

Or:

talespire-encoding==1.2.3

Basic Usage

The Python import package is ts_encoding.

Example:

from ts_encoding.slab import TSSlab
from ts_encoding.creature_bp import TSCreature

Versioning Recommendations

If your application depends on specific functionality or behavior, it is recommended to pin the version you have tested against.

Example:

talespire-encoding==1.2.3

This ensures your users receive a known-compatible version.

Applications that prefer newer functionality can instead use version ranges:

talespire-encoding>=1.2,<2

Dynamic Installation Inside Applications

Some applications (such as DCC tools, Houdini integrations, or standalone launchers) may wish to install the package automatically at runtime.

Example:

python -m pip install talespire-encoding==1.2.3

For embedded Python environments, such as Houdini:

hython -m pip install talespire-encoding==1.2.3

A custom install location can also be specified:

python -m pip install --target ./python_libs talespire-encoding==1.2.3

This allows applications to manage their own isolated dependencies without requiring a system-wide install.

Development Installation

For contributors or developers working directly on the repository:

pip install -e .[dev]

This installs the package in editable mode along with development dependencies such as pytest.

Reporting Issues

Issues, feature requests, and compatibility problems can be reported on the project repository:

TaleSpire-Encoding-Python GitHub Repository

Clone this wiki locally