Skip to content

Latest commit

 

History

History
76 lines (62 loc) · 2.91 KB

README.md

File metadata and controls

76 lines (62 loc) · 2.91 KB

Arnelify Logo

Arnelify Router for Python C++ G++ Python Nuitka

🚀 About

Arnelify® Router for Python - is a minimalistic dynamic library which is a router written in C and C++.

📋 Minimal Requirements

Important: It's strongly recommended to use in a container that has been built from the gcc v14.2.0 image.

  • CPU: Apple M1 / Intel Core i7 / AMD Ryzen 7
  • OS: Debian 11 / MacOS 15 / Windows 10 with WSL2.
  • RAM: 4 GB

📦 Installation

Installing via pip:

pip install arnelify-router

🎉 Usage

Install dependencies:

make install

Compile library:

make build

Compile & Run test:

make test_nuitka

Run test:

make test

📚 Code Examples

Configure the C/C++ IntelliSense plugin for VSCode (optional).

Clang_format_fallback = Google

IncludePath for VSCode (optional):

"includePath": [
  "/opt/homebrew/Cellar/jsoncpp/1.9.6/include/json",
  "${workspaceFolder}/src/cpp",
  "${workspaceFolder}/src"
],

You can find code examples here.

⚖️ MIT License

This software is licensed under the MIT License. The original author's name, logo, and the original name of the software must be included in all copies or substantial portions of the software.

🛠️ Contributing

Join us to help improve this software, fix bugs or implement new functionality. Active participation will help keep the software up-to-date, reliable, and aligned with the needs of its users.

⭐ Release Notes

Version 0.7.1 - Minimalistic dynamic library

We are excited to introduce the Arnelify Router dynamic library for Python! Please note that this version is raw and still in active development.

Change log:

  • Minimalistic dynamic library
  • NodeJS (Bun) addon
  • FFI Support

Please use this version with caution, as it may contain bugs and unfinished features. We are actively working on improving and expanding the router's capabilities, and we welcome your feedback and suggestions.

🔗 Mentioned