Generate Shared Memory Segments

gen_shared_memory is toolset for generation of shared memory segment modules.

Developed in python code.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

Table of Contents

• 🚀 Installation
  • Install using pip
  • Install using build
  • Install using py setup
  • Install using docker
• 📦 Dependencies
• 📁 Tool structure
  • ✨ Features
• 📊 Code coverage
• 🛠 Usage
• 📚 Docs
• 👥 Contributing
• 📄 Copyright and licence

🚀 Installation

Used next development environment

Currently there are three ways to install package

• Install process based on using pip mechanism
• Install process based on build mechanism
• Install process based on setup.py mechanism
• Install process based on docker mechanism

Install using pip

gen_shared_memory is located at pypi.org.

You can install by using pip

# python3
pip3 install gen_shared_memory

Install using build

Navigate to release page download and extract release archive.

To install gen_shared_memory type the following

tar xvzf gen_shared_memory-x.y.z.tar.gz
cd gen_shared_memory-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py 
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_shared_memory-*-py3-none-any.whl
rm -f get-pip.py

Install using py setup

Navigate to release page download and extract release archive.

To install gen_shared_memory locate and run setup.py with arguments

tar xvzf gen_shared_memory-x.y.z.tar.gz
cd gen_shared_memory-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info

Install using docker

You can use Dockerfile to create image/container.

📦 Dependencies

gen_shared_memory requires next modules and libraries

• ats-utilities - Python App/Tool/Script Utilities

📁 Tool structure

gen_shared_memory is based on OOP.

Tool structure

    gen_shared_memory/
         ├── core/
         │   ├── __init__.py
         │   ├── model/
         │   │   ├── __init__.py
         │   │   └── project_setup.py
         │   └── service/
         │       ├── engine.py
         │       ├── __init__.py
         │       ├── iservice.py
         │       └── isubprocessor.py
         ├── engine.py
         ├── infrastructure/
         │   ├── cli/
         │   │   ├── engine.py
         │   │   ├── icli.py
         │   │   ├── __init__.py
         │   │   └── setup/
         │   │       ├── bundle.py
         │   │       ├── dep_validator.py
         │   │       ├── dependencies.py
         │   │       ├── factory.py
         │   │       ├── __init__.py
         │   │       ├── keys.py
         │   │       ├── opt_validator.py
         │   │       ├── options.py
         │   │       ├── registry.py
         │   │       └── validator.py
         │   ├── command/
         │   │   ├── command.py
         │   │   ├── gen_shared_memory_command_definition.py
         │   │   ├── gen_shared_memory_command_executor.py
         │   │   ├── icommand_definition.py
         │   │   ├── icommand_executor.py
         │   │   └── __init__.py
         │   ├── config/
         │   │   ├── gen_shared_memory.cfg
         │   │   ├── gen_shared_memory.logo
         │   │   ├── scheme.json
         │   │   └── templates.tgz
         │   ├── __init__.py
         │   └── subprocessor.py
         ├── __init__.py
         ├── py.typed
         └── setup/
             ├── bundle.py
             ├── dep_validator.py
             ├── dependencies.py
             ├── factory.py
             ├── __init__.py
             ├── keys.py
             ├── opt_validator.py
             ├── options.py
             ├── registry.py
             └── validator.py

     10 directories, 45 files

✨ Features

• Automatically scaffolds POSIX shared memory projects with clean, standardized C code (server.c, client.c, shared_memory.h, Makefile).
• Provides a modular and extensible architecture based on OOP and SOLID principles (Hexagonal / Ports & Adapters).
• Includes command line interface (CLI) support via a command/executor structure.
• Robust validation of project bundles, dependencies, and options.
• Modern template system using gzip archive (templates.tgz) and JSON configuration schema (scheme.json).
• High code quality with full type annotations, 10.00/10 Pylint score, and 100% unit test coverage.

📊 Code coverage

🛠 Usage

Install package

pip3 install gen_shared_memory

Prepare main entry point by downloading main.py or create your own.

wget -O main.py https://raw.githubusercontent.com/vroncevic/gen_shared_memory/main/main.py

Running tool for creating new shared memory project:

python3 main.py create --name myshm --output ./demo/

📚 Docs

More documentation and info at

• gen-shared-memory.readthedocs.io
• www.python.org

👥 Contributing

Contributing to gen_shared_memory

📄 Copyright and licence

Copyright (C) 2018 - 2026 by vroncevic.github.io/gen_shared_memory

gen_shared_memory is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.