Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/electux/gen_gtkmm

GTKMM Project Generator
https://github.com/electux/gen_gtkmm

cc code-generation freebsd gtk gtkmm gtkmm3 gtkmm4 linux macos python3 qnx unix

Last synced: 3 months ago
JSON representation

GTKMM Project Generator

Host: GitHub
URL: https://github.com/electux/gen_gtkmm
Owner: electux
License: gpl-3.0
Created: 2021-11-08T22:41:44.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-07-21T11:41:08.000Z (7 months ago)
Last Synced: 2024-10-28T16:43:50.713Z (3 months ago)
Topics: cc, code-generation, freebsd, gtk, gtkmm, gtkmm3, gtkmm4, linux, macos, python3, qnx, unix
Language: C++
Homepage: https://electux.github.io/gen_gtkmm
Size: 4.02 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# GTK-- project skeleton generator

**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)

**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)

### 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)