Metadata-Version: 2.4
Name: pyassimp
Version: 6.0.2
Summary: Python bindings for the Open Asset Import Library (ASSIMP)
Author-email: ASSIMP Developers <kim.kulling@assimp.org>
Maintainer-email: Séverin Lemaignan <severin@guakamole.org>
License-Expression: ISC
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Provides-Extra: test
Requires-Dist: pytest>=9; extra == "test"
Provides-Extra: release
Requires-Dist: build; extra == "release"
Requires-Dist: twine; extra == "release"
Dynamic: license-file

PyAssimp Readme
===============

A simple Python wrapper for Assimp using `ctypes` to access the library.
Requires Python >= 3.10.

Note that pyassimp is not complete. Many ASSIMP features are missing.

USAGE
-----

### Complete example: 3D viewer

`pyassimp` comes with a simple 3D viewer that shows how to load and display a 3D
model using a shader-based OpenGL pipeline.

![Screenshot](3d_viewer_screenshot.png)

To use it, from within `/port/PyAssimp`:

```console
$ cd scripts
$ python ./3D-viewer <path to your model>
```

You can use this code as starting point in your applications.

### Writing your own code

To get started with `pyassimp`, examine the simpler `sample.py` script in `scripts/`,
which illustrates the basic usage. All Assimp data structures are wrapped using
`ctypes`. All the data+length fields in Assimp's data structures (such as
`aiMesh::mNumVertices`, `aiMesh::mVertices`) are replaced by simple python
lists, so you can call `len()` on them to get their respective size and access
members using `[]`.

For example, to load a file named `hello.3ds` and print the first
vertex of the first mesh, you would do (proper error handling
substituted by assertions ...):

```python

from pyassimp import load
with load('hello.3ds') as scene:

  assert len(scene.meshes)
  mesh = scene.meshes[0]

  assert len(mesh.vertices)
  print(mesh.vertices[0])

```

Another example to list the 'top nodes' in a
scene:

```python

from pyassimp import load
with load('hello.3ds') as scene:

  for c in scene.rootnode.children:
      print(str(c))

```

INSTALL
-------

Install `pyassimp` by running:

```console
$ pip install .
```

PyAssimp requires a assimp dynamic library (`DLL` on windows,
`.so` on linux, `.dylib` on macOS) in order to work. The default search directories are:
  - the current directory
  - on linux additionally: `/usr/lib`, `/usr/local/lib`,
    `/usr/lib/x86_64-linux-gnu`
  - on windows additionally: every directory in `PATH`

The library must match the architecture of your Python interpreter
(e.g. an ARM64 Python on Windows on ARM needs an ARM64 `assimp-*.dll`).

To build that library, refer to the Assimp master `INSTALL`
instructions. To look in more places, edit `./pyassimp/helper.py`.
There's an `additional_dirs` list waiting for your entries.

TEST
----

```console
$ pip install -e ".[test]"
$ LD_LIBRARY_PATH=/path/to/libassimp pytest
```

On Windows (PowerShell), put the directory containing the assimp DLL on `PATH`:

```console
> pip install -e ".[test]"
> $env:PATH = "C:\path\to\assimp\build\bin\Release;$env:PATH"
> pytest
```

BUILD AND DEPLOY
----------------

PyAssimp is a pure-Python package. Wheels do not bundle `libassimp`; users still
need a matching Assimp shared library at runtime.

Bump `version` in `pyproject.toml` before a release. PyPI does not allow
replacing an existing version; yank and ship a new version if a bad release
goes out.

```console
$ pip install -e ".[release]"
$ python -m build
$ twine check dist/*
$ twine upload dist/*
```

Upload requires PyPI maintainer access for the `pyassimp` project. Prefer
Trusted Publishing from CI when that is set up.
