*******************************************************************************
 - Copyright:   : MARX(R) CryptoTech LP
 - File         : readme.txt
 - Date:        : September 2, 2026
 - Description  : Smarx(R)OS Package for Python (SmarxPython)
 - Tools        : Python 3.8 up to 3.14
 - OS           : Windows 11/10 X64

*******************************************************************************
1. Overview
*******************************************************************************

This document contains an introduction to the SmarxOS(R) Package for Python

With this distributive you can:
   - Add software protection and licensing to your Python applications using SmarxOS(R) API
   - use both local and network licensing modes (SmarxOS(R) Network Server)
   - use all cryptography features of SmarxOS(R) API 
   - Encrypt Python applications with the CRYPTO-BOX(R)
   - Encrypt applications that use the PyTorch machine-learning framework with the CRYPTO-BOX(R)

The package contains the following components:


1.1 Python Libraries (folder /SmarxOS-SDK )
===========================================
The folder contains the Python libraries and API documentation required to develop Python applications 
protected with CRYPTO-BOX(R), including:

-->Python libraries required for CRYPTO-BOX(R) integration for Python versions 3.8 through 3.14.
-->Python API documentation
-->Required supplemental tools for pyprotect/pytorch_protect samples

For detailed SmarxPython API documentation, see:
/SmarxOS-SDK/Python/smarxpython.html


1.2 Sample Code (folder /SmarxOS-Sample)
========================================
The folder contains several examples demonstrating how the CRYPTO-BOX(R)can be integrated into 
Python applications for protection and licensing using different APIs and protection approaches.

The following samples are included:
-->License sample
-->CBIOS_DO sample
-->PyProtect sample
-->PyTorch sample

NOTE 1:
-------
Please refer to the README file in the corresponding sample subfolder for detailed instructions on how to build 
and run the sample.

Note 2:
-------
To run the sample, use the .pyd library from the /SmarxOS-SDK folder that corresponds to your installed Python version.


1.2.1 License Sample (folder /license_sample)
---------------------------------------------
The License sample demonstrates software protection and licensing using the Smarx API.
The sample is based on Smarx API, a high-level, object-oriented interface for implementing software protection 
and software licensing tasks with CRYPTO-BOX(R).
The Smarx API (Protection::ISmarxLicense) allows developers to perform common licensing operations with a 
simple API call implemented in the application code.

The API can be used to:
-Validate a CRYPTO-BOX(R) license and licensing data objects
-Support both local and network licensing scenarios
-Generate a request for a license update
-Execute an activation code (not implemented yet)


1.2.2 CBIOS_DO sample (folder cbios_do_sample)
----------------------------------------------
The "CBIOS_DO" demonstrates basic CYPTO-BOX API calls, such as accessing the internal memory and encryption functions,
or using DataObjects for license management. This gives you direct access to most CRYPTO-BOX functions within Python.

CBIOS_DO sample will suit you if you require a Python API with full control over the CRYPTO-BOX(R), or need maximum 
flexibility for your implementation.

The Python API documentation is available at:
/SmarxOS-SDK/Python/smarxpython.html

For an introduction to API-based implementation and an overview of the
available APIs, please refer to the "Implementation with API" White Paper:
https://www.marx.com/en/support/documents#whitepapers


1.2.3 Pyprotect sample
----------------------
The "PyProtect" sample demonstrates how to protect Python source code by encrypting it with the CRYPTO-BOX(R).
The sample also demonstrates how PyInstaller can be used to package a Python application protected with 
PyProtect into a Windows executable.

More information about pyprotect: https://github.com/ga0/pyprotect


1.2.4 Pytorch sample
--------------------
The "PyTorch" sample demonstrates how to protect a Python application that uses the PyTorch machine-learning 
framework with the CRYPTO-BOX(R).

It shows how protected Python code and PyTorch components can be integrated into an application while using 
the CRYPTO-BOX(R) for software protection and licensing.


*******************************************************************************
2. Version History
*******************************************************************************

1.00  31AUG2020 AM#72283 Initial Version
1.01  15DEC2022 AM#72283 Bugfixes
1.02  31AUG2026 AM#72283 Added support for Python 3.14, added pytorch sample for Code protection

*********** Copyright(c) 2002, 2026 MARX(R) CryptoTech LP ********************

*****************************************************************************/