Skip to content

Commit 264ec4f

Browse files
W2WizardW2Wizard
authored
Merge pull request #155 from codam-coding-college/feature/python
[FEATURE] Implement Python Bindings
2 parents 5b5b7a1 + f59c7bb commit 264ec4f

10 files changed

Lines changed: 784 additions & 54 deletions

File tree

‎.editorconfig‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
indent_style = space
8+
indent_size = 4
9+
end_of_line = lf
10+
charset = utf-8
11+
trim_trailing_whitespace = false
12+
13+
[*.{js,jsx,ts,tsx,css,scss,html,svelte,postcss,glsl,c,h}]
14+
indent_size = 2
15+
indent_style = tab
16+
trim_trailing_whitespace = true

‎CMakeLists.txt‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,11 @@ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
2323
list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
2424

2525
# Options
26-
set(DEBUG OFF CACHE BOOL "Build MLX42 in debug mode, enabling assertions")
27-
set(GLFW_FETCH ON CACHE BOOL "Clone and install GLFW")
28-
set(BUILD_TESTS OFF CACHE BOOL "Build the tests to verify the integrity of the lib")
26+
# -----------------------------------------------------------------------------
27+
option(BUILD_SHARED_LIBS "Build mlx42 as a shared library." OFF)
28+
set(DEBUG OFF CACHE BOOL "Build MLX42 in debug mode, enabling assertions")
29+
set(GLFW_FETCH ON CACHE BOOL "Clone and install GLFW")
30+
set(BUILD_TESTS OFF CACHE BOOL "Build the tests to verify the integrity of the lib")
2931

3032
# Compile Options
3133
# -----------------------------------------------------------------------------
@@ -99,7 +101,9 @@ add_custom_command(
99101

100102
# Sources
101103
# -----------------------------------------------------------------------------
102-
add_library(mlx42 STATIC
104+
# The library type is now determined by the BUILD_SHARED_LIBS option.
105+
# By default, it builds a STATIC library.
106+
add_library(mlx42 # Changed from "add_library(mlx42 STATIC"
103107

104108
# Root
105109
${SOURCE_DIR}/mlx_cursor.c
@@ -134,6 +138,16 @@ add_library(mlx42 STATIC
134138
)
135139
target_include_directories(mlx42 PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
136140

141+
# Add this block to control symbol visibility for shared library builds
142+
if(BUILD_SHARED_LIBS)
143+
set_target_properties(mlx42 PROPERTIES
144+
C_VISIBILITY_PRESET hidden
145+
CXX_VISIBILITY_PRESET hidden
146+
)
147+
target_compile_definitions(mlx42 PRIVATE MLX42_BUILD_SHARED)
148+
endif()
149+
150+
137151
# Dependencies
138152
# -----------------------------------------------------------------------------
139153

@@ -192,4 +206,4 @@ install(TARGETS mlx42
192206
RUNTIME DESTINATION "${CMAKE_INSTALL_BINDIR}"
193207
ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
194208
LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
195-
)
209+
)

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@ You can pass build [options](./docs/index.md#available-options) to cmake, e.g: `
117117

118118
You can find an example makefile in the documentation [here](https://github.com/codam-coding-college/MLX42/blob/master/docs/Basics.md).
119119

120+
#### Bindings (Python, etc)
121+
MLX42 currently has a [Python FFI binding](./ffi/python/README.md) available.
122+
In order to get it working you need to build the library first as shown above.
123+
The only change is that you need to enable the option `BUILD_SHARED_LIBS` when building with cmake:
124+
```bash
125+
cmake -B build -DBUILD_SHARED_LIBS=ON && cmake --build build --parallel
126+
```
127+
120128
----
121129

122130
## For MacOS:

‎docs/assets/python.png‎

75.1 KB
Loading

‎ffi/python/.gitignore‎

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
# Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
# poetry.lock
109+
# poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
# pdm.lock
116+
# pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
# pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# Redis
135+
*.rdb
136+
*.aof
137+
*.pid
138+
139+
# RabbitMQ
140+
mnesia/
141+
rabbitmq/
142+
rabbitmq-data/
143+
144+
# ActiveMQ
145+
activemq-data/
146+
147+
# SageMath parsed files
148+
*.sage.py
149+
150+
# Environments
151+
.env
152+
.envrc
153+
.venv
154+
env/
155+
venv/
156+
ENV/
157+
env.bak/
158+
venv.bak/
159+
160+
# Spyder project settings
161+
.spyderproject
162+
.spyproject
163+
164+
# Rope project settings
165+
.ropeproject
166+
167+
# mkdocs documentation
168+
/site
169+
170+
# mypy
171+
.mypy_cache/
172+
.dmypy.json
173+
dmypy.json
174+
175+
# Pyre type checker
176+
.pyre/
177+
178+
# pytype static type analyzer
179+
.pytype/
180+
181+
# Cython debug symbols
182+
cython_debug/
183+
184+
# PyCharm
185+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187+
# and can be added to the global gitignore or merged into this file. For a more nuclear
188+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
189+
# .idea/
190+
191+
# Abstra
192+
# Abstra is an AI-powered process automation framework.
193+
# Ignore directories containing user credentials, local state, and settings.
194+
# Learn more at https://abstra.io/docs
195+
.abstra/
196+
197+
# Visual Studio Code
198+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
201+
# you could uncomment the following to ignore the entire vscode folder
202+
# .vscode/
203+
204+
# Ruff stuff:
205+
.ruff_cache/
206+
207+
# PyPI configuration file
208+
.pypirc
209+
210+
# Marimo
211+
marimo/_static/
212+
marimo/_lsp/
213+
__marimo__/
214+
215+
# Streamlit
216+
.streamlit/secrets.toml

‎ffi/python/README.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Python Bindings for MLX42
2+
3+
This directory contains Python bindings for the MLX42 graphics library, allowing you to use MLX42 functionalities in Python applications (using ^=3.13).
4+
5+
## Building
6+
7+
```bash
8+
git clone https://github.com/codam-coding-college/MLX42.git
9+
cd MLX42
10+
cmake -B build -DBUILD_SHARED_LIBS=ON && cmake --build build --parallel
11+
```
12+
13+
Within MLX42's root directory, there is an example script located at `ffi/python/example.py`.
14+
You can run this script to see how to use the Python bindings:
15+
16+
In case you have a static library (`libmlx42.a`), you can create a shared library from it using `clang` or `gcc`:
17+
```bash
18+
clang -shared -o libmlx42.so libmlx42.a
19+
```
20+
21+
Afterwards, place the shared library in the `ffi/python/` directory:
22+
```bash
23+
# You can also move the shared library onto a system path
24+
mv build/libmlx42.so ffi/python/libmlx42.so
25+
cd ffi/python
26+
python3 example.py
27+
```
28+
29+
# Example Output
30+
![Example Output](../../docs/assets/python.png)

0 commit comments

Comments
 (0)