steino
/
cpy3
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update Readme to better explain requirement to build the package

master
Maxime mouial 2019-11-26 10:45:58 -07:00
parent 0ae938000d
commit 6ed25e33b3
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,5 +1,6 @@
go-python3 # go-python3
==========
**Currently supports python-3.7 only.**
Golang bindings for the C-API of CPython-3. Golang bindings for the C-API of CPython-3.
@ -8,23 +9,26 @@ This package provides a ``go`` package named "python" under which most of the
exposed. Theoretically, you should be able use https://docs.python.org/3/c-api exposed. Theoretically, you should be able use https://docs.python.org/3/c-api
and know what to type in your ``go`` program. and know what to type in your ``go`` program.
Currently supports python-3.7+.
This project was inspired by https://github.com/sbinet/go-python. Go and take a look if we need something for python-2.7! This project was inspired by https://github.com/sbinet/go-python. Go and take a look if we need something for python-2.7!
Install # Install
-------
Simply `go get github.com/DataDog/go-python3` ## Deps
We will need `pkg-config` and a working `python3.7` environment to build these
bindings. Make sure you have Python libraries and header files installed as
well (`python3.7-dev` on Debian or `python3-devel` on Centos for example)..
Build By default `pkg-config` will look at the `python3` library so if you want to
----- choose a specific version just symlink `python-X.Y.pc` to `python3.pc` or use
the `PKG_CONFIG_PATH` environment variable.
We will need `pkg-config` and a working `python3` environment to build these bindings. By default `pkg-config` will look at the `python3` library so if you want to choose a specific version just symlink `python-X.Y.pc` to `python3.pc` or use the `PKG_CONFIG_PATH` environment variable. ## Go get
API Then simply `go get github.com/DataDog/go-python3`
---
# API
Some functions mix go code and call to Python function. Those functions will Some functions mix go code and call to Python function. Those functions will
return and `int` and `error` type. The `int` represent the Python result code return and `int` and `error` type. The `int` represent the Python result code
@ -41,4 +45,4 @@ and error will be set if we failed to open `filename`.
If an error is raise before calling th CPython function `int` default to `-1`. If an error is raise before calling th CPython function `int` default to `-1`.
Take a look at some [examples](examples) Take a look at some [examples](examples)