Generate RPI project configuration/build setup

armpicom is toolset for generation of RPI PICO project configuration/build setup.

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

armpicom is located at pypi.org.

You can install by using pip

# python3
pip3 install armpicom

Install using build

Navigate to release page download and extract release archive.

To install armpicom type the following

tar xvzf armpicom-x.y.z.tar.gz
cd armpicom-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/armpicom-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/armpicom_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/armpicom_run.py /usr/local/bin/armpicom_run.py

Install using py setup

Navigate to release page download and extract release archive.

To install armpicom locate and run setup.py with arguments

tar xvzf armpicom-x.y.z.tar.gz
cd armpicom-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

armpicom requires next modules and libraries

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

📁 Tool structure

armpicom is based on OOP.

Tool structure

    armpicom/
         ├── 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_picom_command_definition.py
         │   │   ├── gen_picom_command_executor.py
         │   │   ├── icommand_definition.py
         │   │   ├── icommand_executor.py
         │   │   └── __init__.py
         │   ├── config/
         │   │   ├── armpicom.cfg
         │   │   ├── armpicom.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 Raspberry Pi Pico projects with proper configuration and build setups.
• Provides a modular and extensible architecture based on OOP and SOLID principles.
• Includes command line interface (CLI) support via a command/executor structure.
• Robust validation of project bundles, dependencies, and options.
• Comes with configurable templates and JSON schema definitions.
• High code quality with full type checking and 100% unit test coverage.

📊 Code coverage

🛠 Usage

Install package

pip3 install armpicom

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

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

Running tool for creating new ARM Pico M project

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

📚 Docs

More documentation and info at

• armpicom.readthedocs.io
• www.python.org

👥 Contributing

Contributing to armpicom

📄 Copyright and licence

Copyright (C) 2021 - 2026 by vroncevic.github.io/armpicom

armpicom 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.