diff options
Diffstat (limited to 'python-milksnake.spec')
| -rw-r--r-- | python-milksnake.spec | 463 |
1 files changed, 463 insertions, 0 deletions
diff --git a/python-milksnake.spec b/python-milksnake.spec new file mode 100644 index 0000000..015b8a0 --- /dev/null +++ b/python-milksnake.spec @@ -0,0 +1,463 @@ +%global _empty_manifest_terminate_build 0 +Name: python-milksnake +Version: 0.1.5 +Release: 1 +Summary: A python library that extends setuptools for binary extensions. +License: Apache License 2.0 +URL: https://pypi.org/project/milksnake/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f9/6d/b55d227c75643445fb5bcd496ab21e543550330ba58a3d791efe973d39c1/milksnake-0.1.5.zip +BuildArch: noarch + +Requires: python3-cffi + +%description +# Milksnake + +<a href="https://pypi.python.org/pypi/milksnake"><img src="https://img.shields.io/pypi/v/milksnake.svg" alt=""></a> +<a href="https://travis-ci.org/getsentry/milksnake"><img src="https://travis-ci.org/getsentry/milksnake.svg?branch=master" alt=""></a> +<a href="https://github.com/getsentry/milksnake/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/milksnake.svg" alt=""></a> + + +Milksnake is an extension for setuptools that allows you to distribute +dynamic linked libraries in Python wheels in the most portable way imaginable. + +It gives you a hook to invoke your own build process and to then take the +resulting dynamic linked library. + +## Why? + +There are already other projects that make Python and native libraries play +along but this one is different. Unlike other projects that build Python +extension modules the goal of this project is to build regular native libraries +that are then loaded with CFFI at runtime. Why not just use CFFI? Because +CFFI's setuptools support alone does not properly work with such wheels (it +does not provide a way to build and properly tag wheels for shared libraries) and +it does not provide a good way to invoke an external build process (like a +makefile, cargo to build rust binaries etc.) + +In particular you will most likely only need two wheels for Linux, one for macs +and soon one for Windows independently of how many Python interpreters you want +to target. + +## What is supported? + +* Platforms: Linux, Mac, Windows +* setuptools commands: `bdist_wheel`, `build`, `build_ext`, `develop` +* `pip install --editable .` +* Universal wheels (`PACKAGE-py2.py3-none-PLATFORM.whl`); this can be disabled + with `milksnake_universal=False` in `setup()` in case the package also contains + stuff that does link against libpython. + +## How? + +This example shows how to build a rust project with it: + +This is what a `setup.py` file looks like: + +```python +from setuptools import setup + +def build_native(spec): + # build an example rust library + build = spec.add_external_build( + cmd=['cargo', 'build', '--release'], + path='./rust' + ) + + spec.add_cffi_module( + module_path='example._native', + dylib=lambda: build.find_dylib('example', in_path='target/release'), + header_filename=lambda: build.find_header('example.h', in_path='target'), + rtld_flags=['NOW', 'NODELETE'] + ) + +setup( + name='example', + version='0.0.1', + packages=['example'], + zip_safe=False, + platforms='any', + setup_requires=['milksnake'], + install_requires=['milksnake'], + milksnake_tasks=[ + build_native + ] +) +``` + +You then need a `rust/` folder that has a Rust library (with a crate type +of `cdylib`) and a `example/` python package. + +Example `example/__init__.py` file: + +```python +from example._native import ffi, lib + + +def test(): + return lib.a_function_from_rust() +``` + +And a `rust/src/lib.rs`: + +```rust +#[no_mangle] +pub unsafe extern "C" fn a_function_from_rust() -> i32 { + 42 +} +``` + +And the `rust/Cargo.toml`: + +```toml +[package] +name = "example" +version = "0.1.0" +build = "build.rs" + +[lib] +name = "example" +crate-type = ["cdylib"] + +[build-dependencies] +cbindgen = "0.4" +``` + +And finally the build.rs file: + +```rust +extern crate cbindgen; + +use std::env; + +fn main() { + let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); + let mut config: cbindgen::Config = Default::default(); + config.language = cbindgen::Language::C; + cbindgen::generate_with_config(&crate_dir, config) + .unwrap() + .write_to_file("target/example.h"); +} +``` + + + + +%package -n python3-milksnake +Summary: A python library that extends setuptools for binary extensions. +Provides: python-milksnake +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-milksnake +# Milksnake + +<a href="https://pypi.python.org/pypi/milksnake"><img src="https://img.shields.io/pypi/v/milksnake.svg" alt=""></a> +<a href="https://travis-ci.org/getsentry/milksnake"><img src="https://travis-ci.org/getsentry/milksnake.svg?branch=master" alt=""></a> +<a href="https://github.com/getsentry/milksnake/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/milksnake.svg" alt=""></a> + + +Milksnake is an extension for setuptools that allows you to distribute +dynamic linked libraries in Python wheels in the most portable way imaginable. + +It gives you a hook to invoke your own build process and to then take the +resulting dynamic linked library. + +## Why? + +There are already other projects that make Python and native libraries play +along but this one is different. Unlike other projects that build Python +extension modules the goal of this project is to build regular native libraries +that are then loaded with CFFI at runtime. Why not just use CFFI? Because +CFFI's setuptools support alone does not properly work with such wheels (it +does not provide a way to build and properly tag wheels for shared libraries) and +it does not provide a good way to invoke an external build process (like a +makefile, cargo to build rust binaries etc.) + +In particular you will most likely only need two wheels for Linux, one for macs +and soon one for Windows independently of how many Python interpreters you want +to target. + +## What is supported? + +* Platforms: Linux, Mac, Windows +* setuptools commands: `bdist_wheel`, `build`, `build_ext`, `develop` +* `pip install --editable .` +* Universal wheels (`PACKAGE-py2.py3-none-PLATFORM.whl`); this can be disabled + with `milksnake_universal=False` in `setup()` in case the package also contains + stuff that does link against libpython. + +## How? + +This example shows how to build a rust project with it: + +This is what a `setup.py` file looks like: + +```python +from setuptools import setup + +def build_native(spec): + # build an example rust library + build = spec.add_external_build( + cmd=['cargo', 'build', '--release'], + path='./rust' + ) + + spec.add_cffi_module( + module_path='example._native', + dylib=lambda: build.find_dylib('example', in_path='target/release'), + header_filename=lambda: build.find_header('example.h', in_path='target'), + rtld_flags=['NOW', 'NODELETE'] + ) + +setup( + name='example', + version='0.0.1', + packages=['example'], + zip_safe=False, + platforms='any', + setup_requires=['milksnake'], + install_requires=['milksnake'], + milksnake_tasks=[ + build_native + ] +) +``` + +You then need a `rust/` folder that has a Rust library (with a crate type +of `cdylib`) and a `example/` python package. + +Example `example/__init__.py` file: + +```python +from example._native import ffi, lib + + +def test(): + return lib.a_function_from_rust() +``` + +And a `rust/src/lib.rs`: + +```rust +#[no_mangle] +pub unsafe extern "C" fn a_function_from_rust() -> i32 { + 42 +} +``` + +And the `rust/Cargo.toml`: + +```toml +[package] +name = "example" +version = "0.1.0" +build = "build.rs" + +[lib] +name = "example" +crate-type = ["cdylib"] + +[build-dependencies] +cbindgen = "0.4" +``` + +And finally the build.rs file: + +```rust +extern crate cbindgen; + +use std::env; + +fn main() { + let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); + let mut config: cbindgen::Config = Default::default(); + config.language = cbindgen::Language::C; + cbindgen::generate_with_config(&crate_dir, config) + .unwrap() + .write_to_file("target/example.h"); +} +``` + + + + +%package help +Summary: Development documents and examples for milksnake +Provides: python3-milksnake-doc +%description help +# Milksnake + +<a href="https://pypi.python.org/pypi/milksnake"><img src="https://img.shields.io/pypi/v/milksnake.svg" alt=""></a> +<a href="https://travis-ci.org/getsentry/milksnake"><img src="https://travis-ci.org/getsentry/milksnake.svg?branch=master" alt=""></a> +<a href="https://github.com/getsentry/milksnake/blob/master/LICENSE"><img src="https://img.shields.io/pypi/l/milksnake.svg" alt=""></a> + + +Milksnake is an extension for setuptools that allows you to distribute +dynamic linked libraries in Python wheels in the most portable way imaginable. + +It gives you a hook to invoke your own build process and to then take the +resulting dynamic linked library. + +## Why? + +There are already other projects that make Python and native libraries play +along but this one is different. Unlike other projects that build Python +extension modules the goal of this project is to build regular native libraries +that are then loaded with CFFI at runtime. Why not just use CFFI? Because +CFFI's setuptools support alone does not properly work with such wheels (it +does not provide a way to build and properly tag wheels for shared libraries) and +it does not provide a good way to invoke an external build process (like a +makefile, cargo to build rust binaries etc.) + +In particular you will most likely only need two wheels for Linux, one for macs +and soon one for Windows independently of how many Python interpreters you want +to target. + +## What is supported? + +* Platforms: Linux, Mac, Windows +* setuptools commands: `bdist_wheel`, `build`, `build_ext`, `develop` +* `pip install --editable .` +* Universal wheels (`PACKAGE-py2.py3-none-PLATFORM.whl`); this can be disabled + with `milksnake_universal=False` in `setup()` in case the package also contains + stuff that does link against libpython. + +## How? + +This example shows how to build a rust project with it: + +This is what a `setup.py` file looks like: + +```python +from setuptools import setup + +def build_native(spec): + # build an example rust library + build = spec.add_external_build( + cmd=['cargo', 'build', '--release'], + path='./rust' + ) + + spec.add_cffi_module( + module_path='example._native', + dylib=lambda: build.find_dylib('example', in_path='target/release'), + header_filename=lambda: build.find_header('example.h', in_path='target'), + rtld_flags=['NOW', 'NODELETE'] + ) + +setup( + name='example', + version='0.0.1', + packages=['example'], + zip_safe=False, + platforms='any', + setup_requires=['milksnake'], + install_requires=['milksnake'], + milksnake_tasks=[ + build_native + ] +) +``` + +You then need a `rust/` folder that has a Rust library (with a crate type +of `cdylib`) and a `example/` python package. + +Example `example/__init__.py` file: + +```python +from example._native import ffi, lib + + +def test(): + return lib.a_function_from_rust() +``` + +And a `rust/src/lib.rs`: + +```rust +#[no_mangle] +pub unsafe extern "C" fn a_function_from_rust() -> i32 { + 42 +} +``` + +And the `rust/Cargo.toml`: + +```toml +[package] +name = "example" +version = "0.1.0" +build = "build.rs" + +[lib] +name = "example" +crate-type = ["cdylib"] + +[build-dependencies] +cbindgen = "0.4" +``` + +And finally the build.rs file: + +```rust +extern crate cbindgen; + +use std::env; + +fn main() { + let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); + let mut config: cbindgen::Config = Default::default(); + config.language = cbindgen::Language::C; + cbindgen::generate_with_config(&crate_dir, config) + .unwrap() + .write_to_file("target/example.h"); +} +``` + + + + +%prep +%autosetup -n milksnake-0.1.5 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-milksnake -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.5-1 +- Package Spec generated |