Create Gtkmm project skeletonΒΆ

gen_gtkmm is tool for creating Gtkmm project skeleton.

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.

gen_gtkmm python checker gen_gtkmm python package github issues documentation status github contributors

πŸš€ InstallationΒΆ

Used next development environment

debian linux os

gen_gtkmm python3 build gen_gtkmm interface checker gen_gtkmm isp checker gen_gtkmm srp checker

Navigate to release page download and extract release archive.

To install gen_gtkmm type the following

tar xvzf gen_gtkmm-x.y.z.tar.gz
cd gen_gtkmm-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_gtkmm-*-py3-none-any.whl
rm -f get-pip.py

You can use Docker to create image/container, or You can use pip to install

# python3
pip3 install gen_gtkmm

πŸ“¦ DependenciesΒΆ

gen_gtkmm requires next modules and libraries

πŸ“ Tool structureΒΆ

gen_gtkmm is based on OOP.

Tool structure

gen_gtkmm/
     β”œβ”€β”€ 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_gtkmm_command_definition.py
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ gen_gtkmm_command_executor.py
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ icommand_definition.py
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ icommand_executor.py
     β”‚Β Β  β”‚Β Β  └── __init__.py
     β”‚Β Β  β”œβ”€β”€ config/
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ gen_gtkmm.cfg
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ gen_gtkmm.logo
     β”‚Β Β  β”‚Β Β  β”œβ”€β”€ scheme.json
     β”‚Β Β  β”‚Β Β  └── templates.tgz
     β”‚Β Β  └── 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, 44 files

✨ Features¢

  • Automatically scaffolds Gtkmm projects with build/make files.

  • 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ΒΆ

Code coverageΒΆ

Name

Stmts

Miss

Cover

gen_gtkmm/__init__.py

8

0

100%

gen_gtkmm/core/__init__.py

9

0

100%

gen_gtkmm/core/model/__init__.py

9

0

100%

gen_gtkmm/core/model/project_setup.py

14

0

100%

gen_gtkmm/core/service/__init__.py

9

0

100%

gen_gtkmm/core/service/engine.py

27

0

100%

gen_gtkmm/core/service/iservice.py

14

0

100%

gen_gtkmm/core/service/isubprocessor.py

14

0

100%

gen_gtkmm/engine.py

57

0

100%

gen_gtkmm/infrastructure/cli/__init__.py

9

0

100%

gen_gtkmm/infrastructure/cli/engine.py

39

0

100%

gen_gtkmm/infrastructure/cli/icli.py

14

0

100%

gen_gtkmm/infrastructure/cli/setup/__init__.py

9

0

100%

gen_gtkmm/infrastructure/cli/setup/bundle.py

22

0

100%

gen_gtkmm/infrastructure/cli/setup/dep_validator.py

36

0

100%

gen_gtkmm/infrastructure/cli/setup/dependencies.py

18

0

100%

gen_gtkmm/infrastructure/cli/setup/factory.py

35

0

100%

gen_gtkmm/infrastructure/cli/setup/keys.py

26

0

100%

gen_gtkmm/infrastructure/cli/setup/opt_validator.py

36

0

100%

gen_gtkmm/infrastructure/cli/setup/options.py

15

0

100%

gen_gtkmm/infrastructure/cli/setup/registry.py

24

0

100%

gen_gtkmm/infrastructure/cli/setup/validator.py

43

0

100%

gen_gtkmm/infrastructure/command/__init__.py

9

0

100%

gen_gtkmm/infrastructure/command/command.py

16

0

100%

gen_gtkmm/infrastructure/command/gen_gtkmm_command_definition.py

24

0

100%

gen_gtkmm/infrastructure/command/gen_gtkmm_command_executor.py

21

0

100%

gen_gtkmm/infrastructure/command/icommand_definition.py

14

0

100%

gen_gtkmm/infrastructure/command/icommand_executor.py

13

0

100%

gen_gtkmm/infrastructure/subprocessor.py

55

0

100%

gen_gtkmm/setup/__init__.py

9

0

100%

gen_gtkmm/setup/bundle.py

23

0

100%

gen_gtkmm/setup/dep_validator.py

36

0

100%

gen_gtkmm/setup/dependencies.py

19

0

100%

gen_gtkmm/setup/factory.py

48

0

100%

gen_gtkmm/setup/keys.py

27

0

100%

gen_gtkmm/setup/opt_validator.py

34

0

100%

gen_gtkmm/setup/options.py

12

0

100%

gen_gtkmm/setup/registry.py

32

0

100%

gen_gtkmm/setup/validator.py

48

0

100%

Total

927

0

100%

πŸ›  UsageΒΆ

Install package

pip3 install gen_gtkmm

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

wget -O main.py https://raw.githubusercontent.com/electux/gen_gtkmm/main/main.py

Running tool for creating new Gtkmm project skeleton

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

πŸ“š DocsΒΆ

More documentation and info at

πŸ‘₯ ContributingΒΆ

Contributing to gen_gtkmm