Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vroncevic/gen_dbus

DBus generator
https://github.com/vroncevic/gen_dbus

dbus generator linux python3 template unix

Last synced: 22 days ago
JSON representation

DBus generator

Host: GitHub
URL: https://github.com/vroncevic/gen_dbus
Owner: vroncevic
License: gpl-3.0
Created: 2021-06-30T16:58:49.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-07-08T16:54:55.000Z (4 months ago)
Last Synced: 2024-10-12T04:29:19.604Z (about 1 month ago)
Topics: dbus, generator, linux, python3, template, unix
Language: Python
Homepage: https://vroncevic.github.io/gen_dbus
Size: 1.45 MB
Stars: 0
Watchers: 3
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

# Generate DBus

**gen_dbus** is tool for generation of [dbus](overview.md) modules.

Developed in **[python](https://www.python.org/)** 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_dbus python checker](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_python_checker.yml/badge.svg)](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_python_checker.yml) [![gen_dbus package checker](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_package_checker.yml/badge.svg)](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_dbus.svg)](https://github.com/vroncevic/gen_dbus/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_dbus.svg)](https://github.com/vroncevic/gen_dbus/graphs/contributors)

**Table of Contents**

- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and Licence](#copyright-and-licence)

### Installation

Used next development environment

![debian linux os](https://raw.githubusercontent.com/vroncevic/gen_dbus/dev/docs/debtux.png)

[![gen_dbus python3 build](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_python3_build.yml/badge.svg)](https://github.com/vroncevic/gen_dbus/actions/workflows/gen_dbus_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

***gen_dbus* is located at **[pypi.org](https://pypi.org/project/gen-dbus/)**.

You can install by using pip

```bash
# python3
pip3 install gen-dbus
```

##### Install using build

Navigate to release **[page](https://github.com/vroncevic/gen_dbus/releases/)** download and extract release archive.

To install **gen_dbus** type the following

```bash
tar xvzf gen_dbus-x.y.z.tar.gz
cd gen_dbus-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_dbus-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_dbus_run.py
ln -s /usr/local/lib/python3.9/dist-packages/usr/local/bin/gen_dbus_run.py /usr/local/bin/gen_dbus_run.py
```

##### Install using py setup

Navigate to release **[page](https://github.com/vroncevic/gen_dbus/releases/)** download and extract release archive.

To install **gen_dbus** locate and run setup.py with arguments

```bash
tar xvzf gen_dbus-x.y.z.tar.gz
cd gen_dbus-x.y.z/
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_data
python3 setup.py install_egg_info
```

##### Install using docker

You can use Dockerfile to create image/container.

### Dependencies

**gen_dbus** requires next modules and libraries

* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_dbus)

### Tool structure

**gen_dbus** is based on OOP

Generator structure

```bash
gen_dbus/
├── conf/
│   ├── gen_dbus.cfg
│   ├── gen_dbus.logo
│   ├── gen_dbus_util.cfg
│   ├── project.yaml
│   └── template/
│   ├── posix_c/
│   │   ├── dbus_client/
│   │   │   ├── AUTHORS.template
│   │   │   ├── autogen.template
│   │   │   ├── ChangeLog.template
│   │   │   ├── configure.template
│   │   │   ├── COPYING.template
│   │   │   ├── Makefile.template
│   │   │   ├── NEWS.template
│   │   │   ├── README.template
│   │   │   └── src/
│   │   │   ├── main.template
│   │   │   └── Makefile.template
│   │   └── dbus_server/
│   │   ├── AUTHORS.template
│   │   ├── autogen.template
│   │   ├── ChangeLog.template
│   │   ├── configure.template
│   │   ├── COPYING.template
│   │   ├── Makefile.template
│   │   ├── NEWS.template
│   │   ├── README.template
│   │   └── src/
│   │   ├── main.template
│   │   └── Makefile.template
│   ├── posix_cxx/
│   │   ├── dbus_client/
│   │   │   ├── AUTHORS.template
│   │   │   ├── autogen.template
│   │   │   ├── ChangeLog.template
│   │   │   ├── configure.template
│   │   │   ├── COPYING.template
│   │   │   ├── Makefile.template
│   │   │   ├── NEWS.template
│   │   │   ├── po/
│   │   │   │   ├── ChangeLog.template
│   │   │   │   ├── LINGUAS.template
│   │   │   │   └── POTFILES.template
│   │   │   ├── README.template
│   │   │   └── src/
│   │   │   ├── main.template
│   │   │   └── Makefile.template
│   │   └── dbus_server/
│   │   ├── AUTHORS.template
│   │   ├── autogen.template
│   │   ├── ChangeLog.template
│   │   ├── configure.template
│   │   ├── COPYING.template
│   │   ├── Makefile.template
│   │   ├── NEWS.template
│   │   ├── po/
│   │   │   ├── ChangeLog.template
│   │   │   ├── LINGUAS.template
│   │   │   └── POTFILES.template
│   │   ├── README.template
│   │   └── src/
│   │   ├── main.template
│   │   └── Makefile.template
│   └── posix_py/
│   ├── dbus_client/
│   │   ├── AUTHORS.template
│   │   ├── autogen.template
│   │   ├── ChangeLog.template
│   │   ├── configure.template
│   │   ├── COPYING.template
│   │   ├── Makefile.template
│   │   ├── NEWS.template
│   │   ├── README.template
│   │   └── src/
│   │   ├── dbus_client.template
│   │   └── Makefile.template
│   └── dbus_server/
│   ├── AUTHORS.template
│   ├── autogen.template
│   ├── ChangeLog.template
│   ├── configure.template
│   ├── COPYING.template
│   ├── Makefile.template
│   ├── NEWS.template
│   ├── README.template
│   └── src/
│   ├── dbus_server.template
│   └── Makefile.template
├── __init__.py
├── log/
│   └── gen_dbus.log
├── pro/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
├── py.typed
└── run/
└── gen_dbus_run.py

23 directories, 77 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_dbus/__init__.py` | 75 | 14 | 81% |
| `gen_dbus/pro/__init__.py` | 64 | 3 | 95% |
| `gen_dbus/pro/read_template.py` | 117 | 17 | 85% |
| `gen_dbus/pro/write_template.py` | 92 | 15 | 84% |
| **Total** | 348 | 49 | 86% |

### Docs

[![Documentation Status](https://readthedocs.org/projects/gen_dbus/badge/?version=latest)](https://gen-dbus.readthedocs.io/en/latest/?badge=latest)