# GTK-- project skeleton generator
<img align="right" src="https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/gen_gtkmm_logo.png" width="25%">
**gen_gtkmm** is toolset for generation GTK-- project skeleton for
developmet of desktop and embedded applications.
Developed in **[python](https://www.python.org/)** code: **100%**.
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_gtkmm python checker](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python_checker.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python_checker.yml) [![gen_gtkmm package checker](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_package_checker.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/electux/gen_gtkmm.svg)](https://github.com/electux/gen_gtkmm/issues) [![GitHub contributors](https://img.shields.io/github/contributors/electux/gen_gtkmm.svg)](https://github.com/electux/gen_gtkmm/graphs/contributors)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using setuptools](#install-using-setuptools)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Copyright and licence](#copyright-and-licence)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
### Installation
![debian linux os](https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/debtux.png)
[![gen_gtkmm python3 build](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python3_build.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python3_build.yml)
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](https://pypi.org/project/gen_gtkmm/)**.
You can install by using pip
```bash
#python3
pip3 install gen_gtkmm
```
##### Install using build
Navigate to release **[page](https://github.com/electux/gen_gtkmm/releases/)** download and extract release archive.
To install **gen_gtkmm** type the following
```bash
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
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_gtkmm_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_gtkmm_run.py /usr/local/bin/gen_gtkmm_run.py
```
##### Install using py setup
Navigate to **[release page](https://github.com/electux/gen_gtkmm/releases)** download and extract release archive.
To install **gen_gtkmm** locate and run setup.py, type the following
```bash
tar xvzf gen_gtkmm-x.y.z.tar.gz
cd gen_gtkmm-x.y.z
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_gtkmm** requires next modules and libraries
* [ats-utilities - Python App/Tool/Script Utilities](https://electux.github.io/ats_utilities)
### Tool structure
**gen_gtkmm** is based on OOP
Generator structure
```bash
gen_gtkmm/
├── conf/
│ ├── gen_gtkmm.cfg
│ ├── gen_gtkmm.logo
│ ├── gen_gtkmm_util.cfg
│ ├── project.yaml
│ └── template/
│ ├── gtkmm3/
│ │ ├── about_header.template
│ │ ├── about_source.template
│ │ ├── application_header.template
│ │ ├── application_source.template
│ │ ├── csflags.template
│ │ ├── cxxflags.template
│ │ ├── help_header.template
│ │ ├── help_source.template
│ │ ├── home_header.template
│ │ ├── home_source.template
│ │ ├── imodel_header.template
│ │ ├── main_source.template
│ │ ├── Makefile.template
│ │ ├── model_header.template
│ │ ├── model_source.template
│ │ ├── objects.template
│ │ ├── odflags.template
│ │ ├── settings_header.template
│ │ ├── settings_source.template
│ │ ├── sources.template
│ │ └── toolchain.template
│ └── gtkmm4/
│ ├── about_header.template
│ ├── about_source.template
│ ├── application_header.template
│ ├── application_source.template
│ ├── csflags.template
│ ├── cxxflags.template
│ ├── help_header.template
│ ├── help_source.template
│ ├── home_header.template
│ ├── home_source.template
│ ├── imodel_header.template
│ ├── main_source.template
│ ├── Makefile.template
│ ├── model_header.template
│ ├── model_source.template
│ ├── objects.template
│ ├── odflags.template
│ ├── settings_header.template
│ ├── settings_source.template
│ ├── sources.template
│ └── toolchain.template
├── __init__.py
├── log/
│ └── gen_gtkmm.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
├── py.typed
└── run/
└── gen_gtkmm_run.py
8 directories, 53 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_gtkmm/__init__.py` | 75 | 14 | 81% |
| `gen_gtkmm/pro/__init__.py` | 61 | 3 | 95% |
| `gen_gtkmm/pro/read_template.py` | 57 | 3 | 95% |
| `gen_gtkmm/pro/write_template.py` | 86 | 4 | 95% |
| **Total** | 279 | 24 | 91% |
### Docs
[![Documentation Status](https://readthedocs.org/projects/gen-gtkmm/badge/?version=latest)](https://gen-gtkmm.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [gen_gtkmm.readthedocs.io](https://gen-gtkmm.readthedocs.io)
* [www.python.org](https://www.python.org/)
* [www.gtkmm.org](https://www.gtkmm.org/en/)
### Copyright and licence
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2021 - 2024 by [electux.github.io/gen_gtkmm](https://electux.github.io/gen_gtkmm/)
This tool 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](https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/psf-logo-alpha.png)](https://www.python.org/psf/)
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.python.org/psf/donations/)
Raw data
{
"_id": null,
"home_page": "https://electux.github.io/gen_gtkmm/",
"name": "gen-gtkmm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "GTK--, Project, C++, Gtk, Unix, Linux",
"author": "Vladimir Roncevic",
"author_email": "elektron.ronca@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0a/09/d087310a294bdd9791c4c43390c24382dae6b8a001fa5ee41e33a3db0782/gen_gtkmm-1.1.6.tar.gz",
"platform": "POSIX",
"description": "# GTK-- project skeleton generator\n\n<img align=\"right\" src=\"https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/gen_gtkmm_logo.png\" width=\"25%\">\n\n**gen_gtkmm** is toolset for generation GTK-- project skeleton for\ndevelopmet of desktop and embedded applications.\n\nDeveloped in **[python](https://www.python.org/)** code: **100%**.\n\nThe README is used to introduce the modules and provide instructions on\nhow to install the modules, any machine dependencies it may have and any\nother information that should be provided before the modules are installed.\n\n[![gen_gtkmm python checker](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python_checker.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python_checker.yml) [![gen_gtkmm package checker](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_package_checker.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/electux/gen_gtkmm.svg)](https://github.com/electux/gen_gtkmm/issues) [![GitHub contributors](https://img.shields.io/github/contributors/electux/gen_gtkmm.svg)](https://github.com/electux/gen_gtkmm/graphs/contributors)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n**Table of Contents**\n\n- [Installation](#installation)\n - [Install using pip](#install-using-pip)\n - [Install using setuptools](#install-using-setuptools)\n - [Install using docker](#install-using-docker)\n- [Dependencies](#dependencies)\n- [Tool structure](#tool-structure)\n- [Docs](#docs)\n- [Copyright and licence](#copyright-and-licence)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n### Installation\n\n![debian linux os](https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/debtux.png)\n\n[![gen_gtkmm python3 build](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python3_build.yml/badge.svg)](https://github.com/electux/gen_gtkmm/actions/workflows/gen_gtkmm_python3_build.yml)\n\nCurrently there are three ways to install package\n* Install process based on using pip mechanism\n* Install process based on build mechanism\n* Install process based on setup.py mechanism\n* Install process based on docker mechanism\n\n##### Install using pip\n\nPython package is located at **[pypi.org](https://pypi.org/project/gen_gtkmm/)**.\n\nYou can install by using pip\n\n```bash\n#python3\npip3 install gen_gtkmm\n```\n\n##### Install using build\n\nNavigate to release **[page](https://github.com/electux/gen_gtkmm/releases/)** download and extract release archive.\n\nTo install **gen_gtkmm** type the following\n\n```bash\ntar xvzf gen_gtkmm-x.y.z.tar.gz\ncd gen_gtkmm-x.y.z/\n# python3\nwget https://bootstrap.pypa.io/get-pip.py\npython3 get-pip.py \npython3 -m pip install --upgrade setuptools\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade build\npip3 install -r requirements.txt\npython3 -m build --no-isolation --wheel\npip3 install ./dist/gen_gtkmm-*-py3-none-any.whl\nrm -f get-pip.py\nchmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_gtkmm_run.py\nln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_gtkmm_run.py /usr/local/bin/gen_gtkmm_run.py\n```\n\n##### Install using py setup\n\nNavigate to **[release page](https://github.com/electux/gen_gtkmm/releases)** download and extract release archive.\n\nTo install **gen_gtkmm** locate and run setup.py, type the following\n\n```bash\ntar xvzf gen_gtkmm-x.y.z.tar.gz\ncd gen_gtkmm-x.y.z\n#python3\npip3 install -r requirements.txt\npython3 setup.py install_lib\npython3 setup.py install_egg_info\npython3 setup.py install_data\n```\n\n##### Install using docker\n\nYou can use Dockerfile to create image/container.\n\n### Dependencies\n\n**gen_gtkmm** requires next modules and libraries\n\n* [ats-utilities - Python App/Tool/Script Utilities](https://electux.github.io/ats_utilities)\n\n### Tool structure\n\n**gen_gtkmm** is based on OOP\n\nGenerator structure\n\n```bash\n gen_gtkmm/\n \u251c\u2500\u2500 conf/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_gtkmm.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_gtkmm.logo\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gen_gtkmm_util.cfg\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 project.yaml\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 template/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 gtkmm3/\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 about_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 about_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 application_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 application_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 csflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 cxxflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 help_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 help_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 home_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 home_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 imodel_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 main_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 Makefile.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 model_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 model_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 objects.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 odflags.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 settings_header.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 settings_source.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 sources.template\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 toolchain.template\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 gtkmm4/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 about_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 about_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 application_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 application_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 csflags.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 cxxflags.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 help_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 help_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 home_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 home_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 imodel_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 main_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 Makefile.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 model_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 model_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 objects.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 odflags.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 settings_header.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 settings_source.template\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 sources.template\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 toolchain.template\n \u251c\u2500\u2500 __init__.py\n \u251c\u2500\u2500 log/\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 gen_gtkmm.log\n \u251c\u2500\u2500 pro/\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 read_template.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 write_template.py\n \u251c\u2500\u2500 py.typed\n \u2514\u2500\u2500 run/\n \u2514\u2500\u2500 gen_gtkmm_run.py\n\n 8 directories, 53 files\n```\n\n### Code coverage\n\n| Name | Stmts | Miss | Cover |\n|------|-------|------|-------|\n| `gen_gtkmm/__init__.py` | 75 | 14 | 81% |\n| `gen_gtkmm/pro/__init__.py` | 61 | 3 | 95% |\n| `gen_gtkmm/pro/read_template.py` | 57 | 3 | 95% |\n| `gen_gtkmm/pro/write_template.py` | 86 | 4 | 95% |\n| **Total** | 279 | 24 | 91% |\n\n### Docs\n\n[![Documentation Status](https://readthedocs.org/projects/gen-gtkmm/badge/?version=latest)](https://gen-gtkmm.readthedocs.io/en/latest/?badge=latest)\n\nMore documentation and info at\n\n* [gen_gtkmm.readthedocs.io](https://gen-gtkmm.readthedocs.io)\n* [www.python.org](https://www.python.org/)\n* [www.gtkmm.org](https://www.gtkmm.org/en/)\n\n### Copyright and licence\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nCopyright (C) 2021 - 2024 by [electux.github.io/gen_gtkmm](https://electux.github.io/gen_gtkmm/)\n\nThis tool is free software; you can redistribute it and/or modify\nit under the same terms as Python itself, either Python version 3.x or,\nat your option, any later version of Python 3 you may have available.\n\nLets help and support PSF.\n\n[![Python Software Foundation](https://raw.githubusercontent.com/electux/gen_gtkmm/dev/docs/psf-logo-alpha.png)](https://www.python.org/psf/)\n\n[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.python.org/psf/donations/)\n",
"bugtrack_url": null,
"license": "GPL 2024 Free software to use and distributed it.",
"summary": "GTK-- project skeleton generator",
"version": "1.1.6",
"project_urls": {
"Homepage": "https://electux.github.io/gen_gtkmm/"
},
"split_keywords": [
"gtk--",
" project",
" c++",
" gtk",
" unix",
" linux"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f280577a4d7af0396ca26156972628d2bdb5b8a612acbcf9e9204a041663b16",
"md5": "44796b102e789efc78b3632f1de96f23",
"sha256": "7b157ae969dcccc74071d7f15c5496b26f40857924bddf2bf08c65d61b513c0d"
},
"downloads": -1,
"filename": "gen_gtkmm-1.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44796b102e789efc78b3632f1de96f23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 61862,
"upload_time": "2024-07-21T11:37:54",
"upload_time_iso_8601": "2024-07-21T11:37:54.531807Z",
"url": "https://files.pythonhosted.org/packages/4f/28/0577a4d7af0396ca26156972628d2bdb5b8a612acbcf9e9204a041663b16/gen_gtkmm-1.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a09d087310a294bdd9791c4c43390c24382dae6b8a001fa5ee41e33a3db0782",
"md5": "c4443bbc83324aedd42f72f9c41eb2fd",
"sha256": "eed03b241f333b50cd15c86306a0a06263e0c79f0c3dbea179e6d4d4a1151a30"
},
"downloads": -1,
"filename": "gen_gtkmm-1.1.6.tar.gz",
"has_sig": false,
"md5_digest": "c4443bbc83324aedd42f72f9c41eb2fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 33886,
"upload_time": "2024-07-21T11:37:56",
"upload_time_iso_8601": "2024-07-21T11:37:56.381935Z",
"url": "https://files.pythonhosted.org/packages/0a/09/d087310a294bdd9791c4c43390c24382dae6b8a001fa5ee41e33a3db0782/gen_gtkmm-1.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-21 11:37:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gen-gtkmm"
}