senpy-ffi
=========

FFI bindings for `senpy-rs <https://github.com/senpy-club/senpy-rs>`_

FFI bindings are great, but safe FFI bindings are even better; in the coming days, I hope to have the time to implement a safe wrapper around these FFI bindings for as many languages as doable so that using The Senpy Club API in any language is just as easy and safe as using :code:`senpy-rs` in Rust.

Notice
------

More FFI examples to come.

Quick links
^^^^^^^^^^^

.. raw:: html

  <p>
    <a href="LICENSE">
      <img src="https://img.shields.io/github/license/senpy-club/senpy-ffi"
           alt="License" />
    </a>
    <a href="https://crates.io/crates/senpy-ffi">
      <img src="https://img.shields.io/crates/v/senpy-ffi.svg"
           alt="Crate" />
    </a>
    <a href="https://docs.rs/senpy-ffi">
      <img src="https://docs.rs/senpy-ffi/badge.svg"
           alt="Documentation" />
    </a>
    <a href="https://github.com/senpy-club/senpy-ffi/actions/workflows/check.yaml">
      <img src="https://github.com/senpy-club/senpy-ffi/actions/workflows/check.yaml/badge.svg?branch=main"
           alt="Build Status" />
    </a>
  </p>

Usage Examples
--------------

.. code-block:: shell

  $ python3 examples/ffi.py
  $ luvit examples/ffi.lua
  $ perl examples/ffi.pl
  $ php examples/ffi.php
  $ julia examples/ffi.jl

Examples
--------

.. raw:: html

  Examples can be found within the <a href="./examples"><code>examples/</code></a> directory.

License
^^^^^^^

`GNU General Public License v3.0 <https://github.com/senpy-club/senpy-ffi/blob/main/LICENSE>`_