Skip to main content

openMTPK Python API

Project description

Version Codacy Badge license Codacy Badge clones PyPi Py

Overview

openMTPK is an open-source (intended) mathematics package written in C++ with a primary focus on Numbery Theory and Cryptographic algorithms, Linear Algebra, and Machine/Deep learning concepts as well as a range of language API's. openMTPK aims to provide options for pre-built functions, models, etc. along with modularity for user freedom. Look in the samples folder for examples on how to use some of openMTPK's functionalities.

Installation

openMTPK C++ & Python is tested on the following:

OS Architecture Status
OSX Monterey 12.6.3 x86 darwin
RasPi OS ARMv6/v7 cppRPi
bullseye 11.6 ARMv6 arm6CPP
ubuntu 22.10 ARMv7 arm7CPP
ubuntu 22.10 ARMv8 arm8CPP
ubuntu 22.10 RISCV64 riscCPP
ubuntu 22.10 S390X s390xCPP
ubuntu 22.10 PPC64LE ppc64leCPP

Note Testing on Apple specific hardware (M1, M2) is in progress.

Python

To install the Python interface, use the pip package manager and run the following, pip install openmtpk. Additional hardware support is available with SWIG as a dependency for the pip installation.

Build from source

  • Linux/OSX
  • CMake >=v3.24 (build from source for latest version)
  • C++20
  • g++12
# clone repo
$ git clone git@github.com:akielaries/openMTPK.git
$ cd openMTPK
# create build dir
$ mkdir build && cd build
# create necessary objects and static library
$ cmake -S ..
$ make
# install necessary headers and library in correct directories
$ sudo make install

Note Keep the build directory for easy uninstallation. This process asumes your STDLIB path is /usr/local/lib, where most 3rd-party libs are located if not, run the following:

$ LD_LIBRARY_PATH=/usr/local/lib

To test the installation build some of the example drivers in the projects samples directory.

# compile yourself
$ cd samples
$ g++ cipher.cpp -lopenMTPK -o cipher
$ g++ arith.cpp -lopenMTPK -o arith
# script to test all modules and their drivers
# using the projects root makefile
$ cd scripts && ./all.sh

To uninstall files related to openMTPK, simply run the following:

# enter the build dir from installation
$ cd build
$ sudo make uninstall

Modules

During early stages, modules will be developed in breadth while focusing on depth in later stages of the PRE-V1.0.0 phase. The modules below are all in progress.

  1. Arithmetic
  2. Calculus
    • Differential
  3. Linear Algebra
    • Vector Operations
    • Matrix Operations
  4. Machine/Deep Learning
    • Regression
    • Cross-Validation
    • K-Nearest Neighbors
    • Neural Networks
    • Classifiers
  5. Number Theory
    • Primes
    • Cryptography
  6. Topology/Complex
    • Dynamical Systems
    • Topology
    • Spline

For more details view the project documentation.

Examples

View the simple examples on how to use some of the modules in different languages here.

# clone the repo and enter
$ git clone git@github.com:akielaries/openMTPK.git 
$ cd openMTPK

# to run all examples 
$ ./all.sh

# to remove the generated binaries
$ make clean-mods

# run unit tests and other checking methods
$ make run-tests

# clean up generated test files
$ make clean-tests

Example C++ driver file for running Caesar Cipher & Mono-Alphabetic Substitution Keyword cipher:

#include <iostream>
#include <string>
// include the number theory module header
#include <openMTPK/number_theory.hpp>

int main() {
    // declare CIPHER class obj
    mtpk::Cipher cc;

    /* CAESAR CIPHER */
    std::string text0 = "Plaintext";
    int shift_key_0 = 5;
    std::string hashtext_0 = cc.caesar(text0, shift_key_0);
    std::cout << "Hashtext0 = " << hashtext_0 << std::endl;

    /* TESTING MONOALPHABETIC SUBSTITUION KEYWORD CIPHER */
    std::string shift_key_2 = "Computer";
    std::string text2 = "Password";
    // encode the plaintext
    std::string encoded_text = cc.keyword_encode(shift_key_2);
    // call the cipher function
    std::string hashtext_2 = cc.keyword(text2 , encoded_text);

    std::cout << "Hashtext2 = " << hashtext_2 << std::endl;

    return 0;
}

A Python example showing the same functionalities.

#!/usr/bin/python3
# import the Number Theory module
from openmtpk import nt

c = Cipher()
ciphertext_0 = c.caesar('Plaintext', 5)
print(ciphertext_0)

ciphertext_1 = c.caesar('ATTACKATONCE', 4)
print(ciphertext_1)

text = "Password"
shift = "Computer"
encoded_text = c.keyword_encode(shift);
hashtext = c.keyword(text, encoded_text);
print(hashtext)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openmtpk-0.9.7.tar.gz (77.9 kB view hashes)

Uploaded Source

Built Distributions

openmtpk-0.9.7-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (229.7 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl (244.6 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ i686

openmtpk-0.9.7-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (223.4 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-pp39-pypy39_pp73-macosx_10_9_x86_64.whl (181.5 kB view hashes)

Uploaded PyPy macOS 10.9+ x86-64

openmtpk-0.9.7-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (229.7 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-pp38-pypy38_pp73-manylinux_2_17_i686.manylinux2014_i686.whl (244.6 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ i686

openmtpk-0.9.7-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (223.6 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-pp38-pypy38_pp73-macosx_10_9_x86_64.whl (181.5 kB view hashes)

Uploaded PyPy macOS 10.9+ x86-64

openmtpk-0.9.7-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (231.4 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-pp37-pypy37_pp73-manylinux_2_17_i686.manylinux2014_i686.whl (246.0 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ i686

openmtpk-0.9.7-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (224.7 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-pp37-pypy37_pp73-macosx_10_9_x86_64.whl (181.4 kB view hashes)

Uploaded PyPy macOS 10.9+ x86-64

openmtpk-0.9.7-cp311-cp311-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp311-cp311-musllinux_1_1_s390x.whl (2.1 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp311-cp311-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp311-cp311-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp311-cp311-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.5 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (1.4 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.4 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp311-cp311-macosx_11_0_arm64.whl (189.3 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

openmtpk-0.9.7-cp311-cp311-macosx_10_9_x86_64.whl (207.9 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

openmtpk-0.9.7-cp310-cp310-musllinux_1_1_x86_64.whl (2.0 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp310-cp310-musllinux_1_1_s390x.whl (2.1 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp310-cp310-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp310-cp310-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp310-cp310-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (1.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.4 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp310-cp310-macosx_11_0_arm64.whl (189.3 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

openmtpk-0.9.7-cp310-cp310-macosx_10_9_x86_64.whl (207.7 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

openmtpk-0.9.7-cp39-cp39-musllinux_1_1_x86_64.whl (2.0 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp39-cp39-musllinux_1_1_s390x.whl (2.1 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp39-cp39-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp39-cp39-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp39-cp39-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (1.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.4 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp39-cp39-macosx_11_0_arm64.whl (189.3 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

openmtpk-0.9.7-cp39-cp39-macosx_10_9_x86_64.whl (207.8 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

openmtpk-0.9.7-cp38-cp38-musllinux_1_1_x86_64.whl (2.0 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp38-cp38-musllinux_1_1_s390x.whl (2.1 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp38-cp38-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp38-cp38-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp38-cp38-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.4 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (1.3 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.4 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp38-cp38-macosx_11_0_arm64.whl (191.9 kB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

openmtpk-0.9.7-cp38-cp38-macosx_10_9_x86_64.whl (210.5 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

openmtpk-0.9.7-cp37-cp37m-musllinux_1_1_x86_64.whl (2.0 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp37-cp37m-musllinux_1_1_s390x.whl (2.0 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp37-cp37m-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp37-cp37m-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp37-cp37m-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.7m musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.4 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.4 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp37-cp37m-manylinux_2_17_i686.manylinux2014_i686.whl (1.3 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp37-cp37m-macosx_10_9_x86_64.whl (209.5 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

openmtpk-0.9.7-cp36-cp36m-musllinux_1_1_x86_64.whl (2.0 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ x86-64

openmtpk-0.9.7-cp36-cp36m-musllinux_1_1_s390x.whl (2.0 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ s390x

openmtpk-0.9.7-cp36-cp36m-musllinux_1_1_ppc64le.whl (2.1 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ ppc64le

openmtpk-0.9.7-cp36-cp36m-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ i686

openmtpk-0.9.7-cp36-cp36m-musllinux_1_1_aarch64.whl (2.0 MB view hashes)

Uploaded CPython 3.6m musllinux: musl 1.1+ ARM64

openmtpk-0.9.7-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ x86-64

openmtpk-0.9.7-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.3 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ s390x

openmtpk-0.9.7-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.4 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ ppc64le

openmtpk-0.9.7-cp36-cp36m-manylinux_2_17_i686.manylinux2014_i686.whl (1.3 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ i686

openmtpk-0.9.7-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (1.3 MB view hashes)

Uploaded CPython 3.6m manylinux: glibc 2.17+ ARM64

openmtpk-0.9.7-cp36-cp36m-macosx_10_9_x86_64.whl (201.3 kB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page