.. These are examples of badges you might want to add to your README:
please update the URLs accordingly
.. image:: https://api.cirrus-ci.com/github/<USER>/mbsim-core.svg?branch=main
:alt: Built Status
:target: https://cirrus-ci.com/github/<USER>/mbsim-core
.. image:: https://readthedocs.org/projects/mbsim-core/badge/?version=latest
:alt: ReadTheDocs
:target: https://mbsim-core.readthedocs.io/en/stable/
.. image:: https://img.shields.io/coveralls/github/<USER>/mbsim-core/main.svg
:alt: Coveralls
:target: https://coveralls.io/r/<USER>/mbsim-core
.. image:: https://img.shields.io/pypi/v/mbsim-core.svg
:alt: PyPI-Server
:target: https://pypi.org/project/mbsim-core/
.. image:: https://img.shields.io/conda/vn/conda-forge/mbsim-core.svg
:alt: Conda-Forge
:target: https://anaconda.org/conda-forge/mbsim-core
.. image:: https://pepy.tech/badge/mbsim-core/month
:alt: Monthly Downloads
:target: https://pepy.tech/project/mbsim-core
.. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter
:alt: Twitter
:target: https://twitter.com/mbsim-core
.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
:alt: Project generated with PyScaffold
:target: https://pyscaffold.org/
.. image:: https://gitlab.com/nee2c/mbsim-core/badges/master/pipeline.svg
.. image:: https://readthedocs.org/projects/mbsim-core/badge/?version=latest
:target: https://mbsim-core.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
|
==========
mbsim-core
==========
Core package for mbsim to deal with some of the boiler plate necessary for prototyping.
This is the module that will allow you to quickly make prototypes and simulate modbus devices and clients.
If you are developing software for production environment, I strongly recommend to use `pymodbus`_ directly.
.. _pymodbus: https://pymodbus.readthedocs.io/en/latest/
Installation
============
To install mbsim you can install from
`gitlab package registry <https://gitlab.com/nee2c/mbsim-core/-/packages/>`_
or
use pip ``pip install mbsim-core``
Usage
=====
We have created a couple of examples to demonstrate making modbus simulators.
They can be found `here`_
.. _here: https://gitlab.com/nee2c/mbsim-core/-/tree/master/examples
Main Package
============
The command line utils can be found in the package `mbsim <https://gitlab.com/nee2c/mbsim>`_.
This package will have utils for modbus server and clients.
.. _pyscaffold-notes:
Making Changes & Contributing
=============================
This project uses `pre-commit`_, please make sure to install it before making any
changes::
pip install pre-commit
cd mbsim-core
pre-commit install
It is a good idea to update the hooks to the latest version::
pre-commit autoupdate
Don't forget to tell your contributors to also install and use pre-commit.
.. _pre-commit: https://pre-commit.com/
Note
====
This project has been set up using PyScaffold 4.1.1. For details and usage
information on PyScaffold see https://pyscaffold.org/.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/nee2c/mbsim-core",
"name": "mbsim-core",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "nee2c",
"author_email": "nico2c3c@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/9f/533912025eaa623edae0e74bba8e556c65bf261c331ab65c7b8acddf9f03/mbsim_core-1.0.1.tar.gz",
"platform": "Linux",
"description": ".. These are examples of badges you might want to add to your README:\n please update the URLs accordingly\n\n .. image:: https://api.cirrus-ci.com/github/<USER>/mbsim-core.svg?branch=main\n :alt: Built Status\n :target: https://cirrus-ci.com/github/<USER>/mbsim-core\n .. image:: https://readthedocs.org/projects/mbsim-core/badge/?version=latest\n :alt: ReadTheDocs\n :target: https://mbsim-core.readthedocs.io/en/stable/\n .. image:: https://img.shields.io/coveralls/github/<USER>/mbsim-core/main.svg\n :alt: Coveralls\n :target: https://coveralls.io/r/<USER>/mbsim-core\n .. image:: https://img.shields.io/pypi/v/mbsim-core.svg\n :alt: PyPI-Server\n :target: https://pypi.org/project/mbsim-core/\n .. image:: https://img.shields.io/conda/vn/conda-forge/mbsim-core.svg\n :alt: Conda-Forge\n :target: https://anaconda.org/conda-forge/mbsim-core\n .. image:: https://pepy.tech/badge/mbsim-core/month\n :alt: Monthly Downloads\n :target: https://pepy.tech/project/mbsim-core\n .. image:: https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter\n :alt: Twitter\n :target: https://twitter.com/mbsim-core\n\n.. image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold\n :alt: Project generated with PyScaffold\n :target: https://pyscaffold.org/\n\n.. image:: https://gitlab.com/nee2c/mbsim-core/badges/master/pipeline.svg\n\n.. image:: https://readthedocs.org/projects/mbsim-core/badge/?version=latest\n :target: https://mbsim-core.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n|\n\n==========\nmbsim-core\n==========\n\nCore package for mbsim to deal with some of the boiler plate necessary for prototyping.\n\nThis is the module that will allow you to quickly make prototypes and simulate modbus devices and clients.\n\nIf you are developing software for production environment, I strongly recommend to use `pymodbus`_ directly.\n\n.. _pymodbus: https://pymodbus.readthedocs.io/en/latest/\n\n\nInstallation\n============\n\nTo install mbsim you can install from\n`gitlab package registry <https://gitlab.com/nee2c/mbsim-core/-/packages/>`_\n\nor\n\nuse pip ``pip install mbsim-core``\n\n\nUsage\n=====\n\nWe have created a couple of examples to demonstrate making modbus simulators.\nThey can be found `here`_\n\n.. _here: https://gitlab.com/nee2c/mbsim-core/-/tree/master/examples\n\n\nMain Package\n============\n\nThe command line utils can be found in the package `mbsim <https://gitlab.com/nee2c/mbsim>`_.\nThis package will have utils for modbus server and clients.\n\n.. _pyscaffold-notes:\n\nMaking Changes & Contributing\n=============================\n\nThis project uses `pre-commit`_, please make sure to install it before making any\nchanges::\n\n pip install pre-commit\n cd mbsim-core\n pre-commit install\n\nIt is a good idea to update the hooks to the latest version::\n\n pre-commit autoupdate\n\nDon't forget to tell your contributors to also install and use pre-commit.\n\n.. _pre-commit: https://pre-commit.com/\n\nNote\n====\n\nThis project has been set up using PyScaffold 4.1.1. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core server for mbsim to start server",
"version": "1.0.1",
"project_urls": {
"Documentation": "http://mbsim-core.rtfd.io/",
"Homepage": "https://gitlab.com/nee2c/mbsim-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb11a0d63624901fa19055a7ac615be91f90b3243021ed0a3429b75abec3b383",
"md5": "4e839f050dc4e4e9265796d9020070ac",
"sha256": "2f41e1a47f53532b952310270f46227342d2c619c4199946f2dcd6701a163016"
},
"downloads": -1,
"filename": "mbsim_core-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e839f050dc4e4e9265796d9020070ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8464,
"upload_time": "2023-08-26T23:06:15",
"upload_time_iso_8601": "2023-08-26T23:06:15.153420Z",
"url": "https://files.pythonhosted.org/packages/bb/11/a0d63624901fa19055a7ac615be91f90b3243021ed0a3429b75abec3b383/mbsim_core-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a49f533912025eaa623edae0e74bba8e556c65bf261c331ab65c7b8acddf9f03",
"md5": "8adc58a6cd5fcfe1d6e395e4d9bf6416",
"sha256": "94ce3c68786b4e3c7826344ee1886443050d071e92dd7813c20e42fa09aea17e"
},
"downloads": -1,
"filename": "mbsim_core-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8adc58a6cd5fcfe1d6e395e4d9bf6416",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 28107,
"upload_time": "2023-08-26T23:06:16",
"upload_time_iso_8601": "2023-08-26T23:06:16.061177Z",
"url": "https://files.pythonhosted.org/packages/a4/9f/533912025eaa623edae0e74bba8e556c65bf261c331ab65c7b8acddf9f03/mbsim_core-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-26 23:06:16",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "nee2c",
"gitlab_project": "mbsim-core",
"lcname": "mbsim-core"
}
JSON