signalkgen


Namesignalkgen JSON
Version 0.2.1 PyPI version JSON
download
home_page
SummaryJSON generator for Signal K Marine data
upload_time2023-03-12 07:28:11
maintainer
docs_urlNone
author
requires_python>=3.11
licenseMIT
keywords json generator signal-k
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Generate Test Data for Navactor
==============

A test data generator for [Signal K](https://signalk.org/specification/1.7.0/doc/data_model.html) json forming time-series graphs of
marine reporters reporting their own info as well as that of their nearest
neighbors'.


see: https://signalk.org/specification/1.7.0/doc/data_model.html

Test output is validated against the Signal K scheme with the [Signal K project's validation tool](https://github.com/SignalK/specification).

also, long live PEP 621

Status
----------

* Generates arrays of boats moving in different directions at different speeds.

* Currently boats reporting other boats is random and the nearest neighbor
feature is not implemented yet.

![Fun Mutation of Dot Output](docs/boats3.png)


Installing
-----------

virtualenv

```
python -m venv venv
source ./venv/bin/activate
python -m pip install --upgrade pip
```

via [Pypi](https://pypi.org/project/signalkgen/)

```
python -m pip install signalkgen
```

Or install with "editing" mode from cloned repo for development of the code.

```
python -m pip install -e .
```

Usage
----------

```
signalkgen --num-boats 300 --nautical-miles 5
```

Validation
-------------

See `tox.ini` or `.github/workflows/check.yml` for automated tests that invoke the Signal K validation tools.

```
git clone https://github.com/SignalK/specification
cd specification
npm install
signalkgen --num-boats 300 --nautical-miles 5 | ./bin/validate.js
```

![Fun Mutation of Dot Output](docs/boats1.png)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "signalkgen",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "json,generator,signal-k",
    "author": "",
    "author_email": "Ed Sweeney <ed@onextent.com>",
    "download_url": "https://files.pythonhosted.org/packages/79/7e/fe7430e9c7fc3929976c3c4a3c55cf4ff0d097736e39f66204d835db6427/signalkgen-0.2.1.tar.gz",
    "platform": null,
    "description": "Generate Test Data for Navactor\n==============\n\nA test data generator for [Signal K](https://signalk.org/specification/1.7.0/doc/data_model.html) json forming time-series graphs of\nmarine reporters reporting their own info as well as that of their nearest\nneighbors'.\n\n\nsee: https://signalk.org/specification/1.7.0/doc/data_model.html\n\nTest output is validated against the Signal K scheme with the [Signal K project's validation tool](https://github.com/SignalK/specification).\n\nalso, long live PEP 621\n\nStatus\n----------\n\n* Generates arrays of boats moving in different directions at different speeds.\n\n* Currently boats reporting other boats is random and the nearest neighbor\nfeature is not implemented yet.\n\n![Fun Mutation of Dot Output](docs/boats3.png)\n\n\nInstalling\n-----------\n\nvirtualenv\n\n```\npython -m venv venv\nsource ./venv/bin/activate\npython -m pip install --upgrade pip\n```\n\nvia [Pypi](https://pypi.org/project/signalkgen/)\n\n```\npython -m pip install signalkgen\n```\n\nOr install with \"editing\" mode from cloned repo for development of the code.\n\n```\npython -m pip install -e .\n```\n\nUsage\n----------\n\n```\nsignalkgen --num-boats 300 --nautical-miles 5\n```\n\nValidation\n-------------\n\nSee `tox.ini` or `.github/workflows/check.yml` for automated tests that invoke the Signal K validation tools.\n\n```\ngit clone https://github.com/SignalK/specification\ncd specification\nnpm install\nsignalkgen --num-boats 300 --nautical-miles 5 | ./bin/validate.js\n```\n\n![Fun Mutation of Dot Output](docs/boats1.png)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "JSON generator for Signal K Marine data",
    "version": "0.2.1",
    "split_keywords": [
        "json",
        "generator",
        "signal-k"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4a8e53d0def017ebed2f20d586fc9dbde234f9190c430a0a18dad656452f002a",
                "md5": "3b5b0a8561a8689ef7267d52130ddbd4",
                "sha256": "3a56341130bd9babb4940fd5308cb64cedba8b82b8218470a8987d15f7fc5e9f"
            },
            "downloads": -1,
            "filename": "signalkgen-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3b5b0a8561a8689ef7267d52130ddbd4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 6070,
            "upload_time": "2023-03-12T07:28:09",
            "upload_time_iso_8601": "2023-03-12T07:28:09.720445Z",
            "url": "https://files.pythonhosted.org/packages/4a/8e/53d0def017ebed2f20d586fc9dbde234f9190c430a0a18dad656452f002a/signalkgen-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "797efe7430e9c7fc3929976c3c4a3c55cf4ff0d097736e39f66204d835db6427",
                "md5": "840a5da64a46eb3fe35a108e0d4b0c1b",
                "sha256": "87e3b6641c1cd88b3ce1da48e23a3d3ee1cf2dffeec6173e85a5cfc606230e8b"
            },
            "downloads": -1,
            "filename": "signalkgen-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "840a5da64a46eb3fe35a108e0d4b0c1b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 4541331,
            "upload_time": "2023-03-12T07:28:11",
            "upload_time_iso_8601": "2023-03-12T07:28:11.630674Z",
            "url": "https://files.pythonhosted.org/packages/79/7e/fe7430e9c7fc3929976c3c4a3c55cf4ff0d097736e39f66204d835db6427/signalkgen-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-12 07:28:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "signalkgen"
}
        
Elapsed time: 0.04204s