nodestream-plugin-pedantic


Namenodestream-plugin-pedantic JSON
Version 0.11.0 PyPI version JSON
download
home_pagehttps://github.com/nodestream-proj/nodestream
SummaryA nodestream plugin that provides a series of audits to ensure high quality and consistent nodestream projects.
upload_time2024-01-22 15:33:55
maintainer
docs_urlNone
authorZach Probst
requires_python>=3.10,<4.0
licenseApache-2.0
keywords etl neo4j declarative data kafka ingest nodestream
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Nodestream pedantic Plugin

This plugin adds a pedantic mode to nodestream. It will check for the following:

- All node types are defined using `CamelCase`.
- All node types are singular (e.g. `User` not `Users`).
- All relationship types are defined using `UPPER_SNAKE_CASE`
- All property names are defined using `lower_snake_case`
- All pipeline names are defined using `lower-case-with-dashes`

## Installation

```bash
pip install nodestream-plugin-pedantic
```

## Usage

```bash
nodestream audit pedantic
```

Will produce output like:

```
Pipeline load_org_chart is not lower dash case. Suggestion: load-org-chart
Node type People is not singular. Suggestion: Person
Property lastName is not snake case. Suggestion: last_name
Node type number is not camel case. Suggestion: Number
Relationship type is_friends_with is not upper camel case. Suggestion: IS_FRIENDS_WITH
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nodestream-proj/nodestream",
    "name": "nodestream-plugin-pedantic",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "etl,neo4j,declarative,data,kafka,ingest,nodestream",
    "author": "Zach Probst",
    "author_email": "Zach_Probst@intuit.com",
    "download_url": "https://files.pythonhosted.org/packages/9a/b4/1eb17b34d6ed0a45e09e16694a82b2deb5b84e4517cb3e48df3e34a61097/nodestream_plugin_pedantic-0.11.0.tar.gz",
    "platform": null,
    "description": "# Nodestream pedantic Plugin\n\nThis plugin adds a pedantic mode to nodestream. It will check for the following:\n\n- All node types are defined using `CamelCase`.\n- All node types are singular (e.g. `User` not `Users`).\n- All relationship types are defined using `UPPER_SNAKE_CASE`\n- All property names are defined using `lower_snake_case`\n- All pipeline names are defined using `lower-case-with-dashes`\n\n## Installation\n\n```bash\npip install nodestream-plugin-pedantic\n```\n\n## Usage\n\n```bash\nnodestream audit pedantic\n```\n\nWill produce output like:\n\n```\nPipeline load_org_chart is not lower dash case. Suggestion: load-org-chart\nNode type People is not singular. Suggestion: Person\nProperty lastName is not snake case. Suggestion: last_name\nNode type number is not camel case. Suggestion: Number\nRelationship type is_friends_with is not upper camel case. Suggestion: IS_FRIENDS_WITH\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A nodestream plugin that provides a series of audits to ensure high quality and consistent nodestream projects.",
    "version": "0.11.0",
    "project_urls": {
        "Documentation": "https://nodestream-proj.github.io/nodestream-plugin-pedantic",
        "Homepage": "https://github.com/nodestream-proj/nodestream",
        "Repository": "https://github.com/nodestream-proj/nodestream-plugin-pedantic"
    },
    "split_keywords": [
        "etl",
        "neo4j",
        "declarative",
        "data",
        "kafka",
        "ingest",
        "nodestream"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d595f00280ab16e95d91d1c08ee410c9fcc2e9509a81b1431c7242e2950f78e",
                "md5": "18531f9f8b21efc346d8c61f53be6f9d",
                "sha256": "3abb8017baa85648727263ff237c702c01ffdf7cbacf57f7d37de7a7bad20f19"
            },
            "downloads": -1,
            "filename": "nodestream_plugin_pedantic-0.11.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "18531f9f8b21efc346d8c61f53be6f9d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 7641,
            "upload_time": "2024-01-22T15:33:54",
            "upload_time_iso_8601": "2024-01-22T15:33:54.615772Z",
            "url": "https://files.pythonhosted.org/packages/1d/59/5f00280ab16e95d91d1c08ee410c9fcc2e9509a81b1431c7242e2950f78e/nodestream_plugin_pedantic-0.11.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ab41eb17b34d6ed0a45e09e16694a82b2deb5b84e4517cb3e48df3e34a61097",
                "md5": "a65431f376304b356416d0def8e52658",
                "sha256": "16cd6961bdcf76c85cf07051bc8b048057c4388b73b2a1cbdc0365e139415959"
            },
            "downloads": -1,
            "filename": "nodestream_plugin_pedantic-0.11.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a65431f376304b356416d0def8e52658",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 6734,
            "upload_time": "2024-01-22T15:33:55",
            "upload_time_iso_8601": "2024-01-22T15:33:55.748293Z",
            "url": "https://files.pythonhosted.org/packages/9a/b4/1eb17b34d6ed0a45e09e16694a82b2deb5b84e4517cb3e48df3e34a61097/nodestream_plugin_pedantic-0.11.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-22 15:33:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nodestream-proj",
    "github_project": "nodestream",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "nodestream-plugin-pedantic"
}
        
Elapsed time: 0.21048s