Skip to content

Latest commit

 

History

History
170 lines (122 loc) · 6.18 KB

README.md

File metadata and controls

170 lines (122 loc) · 6.18 KB

STM8 project skeleton generator

gen_stm8 is toolset for generation STM8 project skeleton for developmet of embedded applications.

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.

gen_stm8 python checker gen_stm8 package checker GitHub issues open GitHub contributors

Table of Contents

Installation

Used next development environment

debian linux os

gen_stm8 python3 build

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

Python package is located at pypi.org.

You can install by using pip

#python3
pip3 install gen_stm8
Install using build

Navigate to release page download and extract release archive.

To install gen_stm8 type the following

tar xvzf gen_stm8-x.y.z.tar.gz
cd gen_stm8-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_stm8-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_stm8_run.py
ln -s /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_stm8_run.py /usr/local/bin/gen_stm8_run.py
Install using py setup

Navigate to release page download and extract release archive.

To install gen_stm8 locate and run setup.py with arguments

tar xvzf gen_stm8-x.y.z.tar.gz
cd gen_stm8-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_stm8 requires next modules and libraries

Tool structure

gen_stm8 is based on OOP.

Generator structure

    gen_stm8/
        ├── conf/
        │   ├── gen_stm8.logo
        │   ├── gen_stm8.cfg
        │   ├── gen_stm8_util.cfg
        │   ├── project.yaml
        │   └── template/
        │       ├── Makefile.template
        │       ├── module.template
        │       └── stm8s.template
        ├── __init__.py
        ├── log/
        │   └── gen_stm8.log
        ├── pro/
        │   ├── __init__.py
        │   ├── read_template.py
        │   └── write_template.py
        └── run/
            ├── factory_reset.sh
            └── gen_stm8_run.py

    6 directories, 14 files

Code coverage

Name Stmts Miss Cover
gen_stm8/__init__.py 71 12 83%
gen_stm8/pro/__init__.py 59 2 97%
gen_stm8/pro/read_template.py 53 2 96%
gen_stm8/pro/write_template.py 62 3 95%
Total 245 19 92%

Docs

Documentation Status

More documentation and info at

Copyright and licence

License: GPL v3 License

Copyright (C) 2018 - 2024 by vroncevic.github.io/gen_stm8

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

Python Software Foundation

Donate