Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/vroncevic/gen_coap_service

Generate CoAP service
https://github.com/vroncevic/gen_coap_service

coap coap-client coap-endpoint coap-protocol coap-server generator linux python3 rfc-7252 template

Last synced: 3 months ago
JSON representation

Generate CoAP service

Host: GitHub
URL: https://github.com/vroncevic/gen_coap_service
Owner: vroncevic
License: gpl-3.0
Created: 2020-01-31T07:02:58.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-07-08T16:19:39.000Z (7 months ago)
Last Synced: 2024-08-10T09:15:14.466Z (6 months ago)
Topics: coap, coap-client, coap-endpoint, coap-protocol, coap-server, generator, linux, python3, rfc-7252, template
Language: Python
Homepage: https://vroncevic.github.io/gen_coap_service
Size: 1.4 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Generates CoAP modules

**gen_coap_service** is tool for generation of CoAP modules.

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_coap_service python checker](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_python_checker.yml/badge.svg)](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_python_checker.yml) [![gen_coap_service package checker](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_package_checker.yml/badge.svg)](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_coap_service.svg)](https://github.com/vroncevic/gen_coap_service/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_coap_service.svg)](https://github.com/vroncevic/gen_coap_service/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)
- [Copyright and Licence](#copyright-and-licence)

### Installation

Used next development environment

![Development environment](https://raw.githubusercontent.com/vroncevic/gen_coap_service/dev/docs/debtux.png)

[![gen_coap_service python3 build](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_python3_build.yml/badge.svg)](https://github.com/vroncevic/gen_coap_service/actions/workflows/gen_coap_service_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-coap-service/)**.

You can install by using pip

```bash
# python3
pip3 install gen-coap-service
```

##### Install using build

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

To install **gen-coap-service** run

```bash
tar xvzf gen-coap-service-x.y.z.tar.gz
cd gen-coap-service-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 -s --no-isolation --wheel
pip3 install dist/gen-coap-service-x.y.z-py3-none-any.whl
rm -f get-pip.py
```

##### Install using py setup

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

To install **gen-coap-service** locate and run setup.py with arguments

```bash
tar xvzf gen_coap_service-x.y.z.tar.gz
cd gen_coap_service-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 docker to create image/container.

### Dependencies

**gen_coap_service** requires next modules and libraries:

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

### Tool structure

**gen_coap_service** is based on OOP.

Generator structure

```bash
gen_coap_service/
├── conf/
│   ├── gen_coap_service.cfg
│   ├── gen_coap_service.logo
│   ├── gen_coap_service_utils.cfg
│   ├── project.yaml
│   └── template/
│   ├── coapthon/
│   │   ├── basic/
│   │   ├── basic_resources.template
│   │   ├── coap_client.template
│   │   ├── coap_server.template
│   │   └── logging.template
│   ├── libcoap/
│   │   ├── coap_client/
│   │   │   ├── autogen.template
│   │   │   ├── build/
│   │   │   │   └── editorconfig.template
│   │   │   ├── configure.template
│   │   │   ├── Makefile.template
│   │   │   ├── README.template
│   │   │   └── src/
│   │   │   ├── client_api.template
│   │   │   ├── main.template
│   │   │   ├── Makefile.template
│   │   │   ├── print_error.template
│   │   │   ├── print_success.template
│   │   │   ├── print_usage.template
│   │   │   ├── print_verbose.template
│   │   │   ├── process_options.template
│   │   │   └── time_handler.template
│   │   └── coap_server/
│   │   ├── autogen.template
│   │   ├── build/
│   │   │   └── editorconfig.template
│   │   ├── configure.template
│   │   ├── Makefile.template
│   │   ├── README.template
│   │   └── src/
│   │   ├── get_date.template
│   │   ├── get_full.template
│   │   ├── get_time.template
│   │   ├── main.template
│   │   ├── Makefile.template
│   │   ├── server_api.template
│   │   └── time_handler.template
│   ├── node_coap/
│   │   ├── client.template
│   │   └── server.template
│   ├── template_coapthon.yaml
│   ├── template_libcoap.yaml
│   └── template_node_coap.yaml
├── __init__.py
├── log/
│   └── gen_coap_service.log
├── pro/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
├── py.typed
└── run/
└── gen_coap_service_run.py

16 directories, 46 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_coap_service/__init__.py` | 75 | 14 | 81% |
| `gen_coap_service/pro/__init__.py` | 85 | 3 | 96% |
| `gen_coap_service/pro/read_template.py` | 38 | 2 | 95% |
| `gen_coap_service/pro/write_template.py` | 40 | 2 | 95% |
| **Total** | 238 | 21 | 91% |

### Docs

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

More documentation and info at:
* [gen_coap_service.readthedocs.io](https://gen-coap-service.readthedocs.io/en/latest/)
* [CoAP Service](overview.md)
* [www.python.org](https://www.python.org/)

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

**gen_coap_service** 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/vroncevic/gen_coap_service/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/)