Generate RPI PICO 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 tool and provide instructions on
how to install the tool, any machine dependencies it may have and any
other information that should be provided before the tool is installed.
|armpicom python checker| |armpicom python package| |armpicom interface checker| |armpicom isp checker| |armpicom srp checker| |github issues| |documentation status| |github contributors|
.. |armpicom python checker| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_python_checker.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_python_checker.yml
.. |armpicom python package| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_package_checker.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_package.yml
.. |armpicom interface checker| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_interface_checker.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_interface_checker.yml
.. |armpicom isp checker| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_isp_checker.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_isp_checker.yml
.. |armpicom srp checker| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_srp_checker.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_srp_checker.yml
.. |github issues| image:: https://img.shields.io/github/issues/vroncevic/armpicom.svg
:target: https://github.com/vroncevic/armpicom/issues
.. |github contributors| image:: https://img.shields.io/github/contributors/vroncevic/armpicom.svg
:target: https://github.com/vroncevic/armpicom/graphs/contributors
.. |documentation status| image:: https://readthedocs.org/projects/armpicom/badge/?version=latest
:target: https://armpicom.readthedocs.io/en/latest/?badge=latest
.. toctree::
:maxdepth: 4
:caption: Contents
self
modules
🚀 Installation
---------------
|armpicom python3 build|
.. |armpicom python3 build| image:: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_python3_build.yml/badge.svg
:target: https://github.com/vroncevic/armpicom/actions/workflows/armpicom_python3_build.yml
Navigate to release `page`_ download and extract release archive.
.. _page: https://github.com/vroncevic/armpicom/releases
To install **armpicom** type the following
.. code-block:: bash
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
You can use Docker to create image/container, or You can use pip to install
.. code-block:: bash
# pyton3
pip3 install armpicom
📦 Dependencies
---------------
**armpicom** requires next modules and libraries
* `ats-utilities - Python App/Tool/Script Utilities `_
📁 Tool structure
-----------------
**armpicom** is based on OOP.
Tool structure
.. code-block:: bash
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
----------------
.. csv-table:: Code coverage
:file: coverage_table.csv
:widths: 60, 10, 10, 20
:header-rows: 1
🛠 Usage
--------
Install package
.. code-block:: bash
pip3 install armpicom
Prepare main entry point by downloading `main.py` or create your own.
.. code-block:: bash
wget -O main.py https://raw.githubusercontent.com/vroncevic/armpicom/main/main.py
Running tool for creating new ARM Pico M project
.. code-block:: bash
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.