package pyml_bindgen
Install
Dune Dependency
Authors
Maintainers
Sources
md5=bfa32570ab50fe360974fe7a4c9ff504
sha512=496beb6364654ad09be5d0f8ae01016a01163105341ed57f5f27eb430c67cea4e6e5aa913375557094d4acf1e29fb4908cab8552b8ae38f50f1f89f7562d4821
Description
Published: 02 Aug 2022
README
OCaml-Python Bindings Generator
Generate Python bindings with pyml directly from OCaml value specifications.
While you could write all your Python bindings by hand, it can be tedious and it gets old real quick. While pyml_bindgen
can't yet auto-generate all the bindings you may need, it can definitely take care of a lot of the tedious and repetitive work you need to do when writing bindings for a big Python library!! 💖
Quick start
First, install pyml_bindgen
. It is available on Opam.
$ opam install pyml_bindgen
Say you have a Python class you want to bind and use in OCaml. (Filename: adder.py
)
class Adder:
@staticmethod
def add(x, y):
return x + y
To do so, you write OCaml value specifications for the class and methods you want to bind. (Filename: val_specs.txt
)
val add : x:int -> y:int -> unit -> int
Then, you run pyml_bindgen
.
$ pyml_bindgen val_specs.txt adder Adder --caml-module Adder > lib.ml
Now you can use your generated functions in your OCaml code. (Filename: run.ml
)
open Lib
let () = Py.initialize ()
let result = Adder.add ~x:1 ~y:2 ()
let () = assert (result = 3)
Finally, set up a dune file and run it.
(executable
(name run)
(libraries pyml))
$ dune exec ./run.exe
Documentation
For information on installing and using pyml_bindgen
, check out the docs.
Additionally, you can find examples in the examples directory. One neat thing about these examples is that you can see how to write Dune rules to automatically generate your pyml
bindings.
You may also want to check out my blog post introducing pyml_bindgen
.
Installing from sources
If you want to install from sources, e.g., to track the main branch or a development branch, but you do not want to install all the test and development packages, clone the repository, checkout the branch you want to follow and install:
$ git clone https://github.com/mooreryan/ocaml_python_bindgen.git
# Checkout whatever branch you want, in this case `dev`.
$ git checkout dev
$ make opam_install
This will save a lot of install time as it avoids some heavy packages.
Development
If instead, you want to work on pyml_bindgen
development, will need to ensure you have the development and test dependencies.
E.g.,
$ git clone https://github.com/mooreryan/ocaml_python_bindgen.git
$ make deps
$ make deps_dev
# Start working!
$ dune test
License
Copyright (c) 2021 - 2022 Ryan M. Moore.
Licensed under the Apache License, Version 2.0 or the MIT license, at your option. This program may not be copied, modified, or distributed except according to those terms.
Dependencies (10)
-
ocaml
>= "4.08.0"
-
stdio
>= "v0.12"
-
re
>= "1.10.0"
-
ppx_string
>= "v0.12"
-
ppx_sexp_conv
>= "v0.12"
-
ppx_let
>= "v0.12"
-
cmdliner
>= "1.1.0"
-
base
>= "v0.12.0" & < "v0.16.0"
-
angstrom
>= "0.15.0"
-
dune
>= "3.0"
Dev Dependencies (9)
-
odoc
with-doc
-
shexp
>= "v0.14" & with-test
-
pyml
with-test
-
ppx_expect
>= "v0.12" & with-test
-
ppx_inline_test
>= "v0.12" & with-test
-
ppx_assert
>= "v0.12" & with-test
-
ocamlformat
>= "0.23" & < "0.24" & with-test
-
base_quickcheck
>= "v0.12" & with-test
-
conf-python-3-dev
>= "1" & with-test
Used by
None
Conflicts
None