pioverifier


Namepioverifier JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/dakalamin/pioverifier
SummaryA simple CLI tool to verify platformio.ini file
upload_time2023-06-27 02:26:29
maintainer
docs_urlNone
authorDaniil Kalamin
requires_python>=3.11
licenseMIT
keywords cli embedded pio platformio verification
VCS
bugtrack_url
requirements click platformio
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ```
█████████████████████████████████████████████████████████████████████████████████████████████████████████████████
████████████████    ███████████████                                  ███              ███                      ██
███████████████████████████████████                                 ░░░      ██████  ░░░                       ██
██          ██      ████        ███  █████ █████  ██████  ████████  ████    ███░░███ ████   ██████  ████████   ██
███    ██    ███    ███    ██    ██  ░███ ░░███  ███░░███░░███░░███░░███   ░███ ░░░ ░░███  ███░░███░░███░░███  ██
███    ██    ███    ███    ██    ██  ░███  ░███ ░███████  ░███ ░░░  ░███  ███████    ░███ ░███████  ░███ ░░░   ██
███    ██    ███    ███    ██    ██  ░░███ ███  ░███░░░   ░███      ░███ ░░░███░     ░███ ░███░░░   ░███       ██
███         ██        ██        ███   ░░█████   ░░██████  █████     █████  ░███      █████░░██████  █████      ██
███    ████████████████████████████    ░░░░░     ░░░░░░  ░░░░░     ░░░░░   ░███     ░░░░░  ░░░░░░  ░░░░░       ██
███    ████████████████████████████                                        ░███                                ██
███    ██████████████████████████████████████████████████████████████████████████████████████████████████████████
```
[![PyPI-Version][version-badge]][version-link] [![PyPI-License][license-badge]](LICENSE)


**Pioverifier** is a simple CLI tool that allows you to verify *platformio.ini* config file
for [PlatformIO](https://platformio.org "Professional collaborative platform for embedded development")-based projects.
It is distributed as a Python package on [PyPI](https://pypi.org "Python Package Index").

## **Package is currently on *planning* stage**
**All the paragraphs below do not reflect the actual functionality for now.**

## Installation

Install and update using [pip](https://pip.pypa.io/en/stable/getting-started "pip documentation"):
``` batchfile
pip install --upgrade pioverifier
```

## Usage

Considering your project has the following structure:
```
project-dir
├── ... (project dirs and files)
└── platformio.ini
```

run these commands in a terminal to perform a verification:
``` batchfile
cd path\to\project-dir
python -m pioverifier
```

alternatively, you can run an equivalent one-line command:
``` batchfile
python -m pioverifier --project-path="path\to\project-dir"
```

[version-badge]: https://img.shields.io/pypi/v/pioverifier?style=flat-square
[version-link]:  https://pypi.python.org/pypi/pioverifier
[license-badge]: https://img.shields.io/pypi/l/pioverifier?style=flat-square

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dakalamin/pioverifier",
    "name": "pioverifier",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": "",
    "keywords": "CLI,embedded,pio,platformio,verification",
    "author": "Daniil Kalamin",
    "author_email": "dakalamin@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/88/41/ff98ccdd2cf8a6f555cd904705bfb4869f0883592ab24fab5659d96678b6/pioverifier-0.1.0.tar.gz",
    "platform": null,
    "description": "```\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588                                  \u2588\u2588\u2588              \u2588\u2588\u2588                      \u2588\u2588\r\n\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588                                 \u2591\u2591\u2591      \u2588\u2588\u2588\u2588\u2588\u2588  \u2591\u2591\u2591                       \u2588\u2588\r\n\u2588\u2588          \u2588\u2588      \u2588\u2588\u2588\u2588        \u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588 \u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588    \u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588 \u2588\u2588\u2588\u2588   \u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588   \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588\u2588    \u2588\u2588\u2588    \u2588\u2588    \u2588\u2588  \u2591\u2588\u2588\u2588 \u2591\u2591\u2588\u2588\u2588  \u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588   \u2591\u2588\u2588\u2588 \u2591\u2591\u2591 \u2591\u2591\u2588\u2588\u2588  \u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588  \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588\u2588    \u2588\u2588\u2588    \u2588\u2588    \u2588\u2588  \u2591\u2588\u2588\u2588  \u2591\u2588\u2588\u2588 \u2591\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2591\u2588\u2588\u2588 \u2591\u2591\u2591  \u2591\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2591\u2588\u2588\u2588 \u2591\u2588\u2588\u2588\u2588\u2588\u2588\u2588  \u2591\u2588\u2588\u2588 \u2591\u2591\u2591   \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588    \u2588\u2588\u2588    \u2588\u2588\u2588    \u2588\u2588    \u2588\u2588  \u2591\u2591\u2588\u2588\u2588 \u2588\u2588\u2588  \u2591\u2588\u2588\u2588\u2591\u2591\u2591   \u2591\u2588\u2588\u2588      \u2591\u2588\u2588\u2588 \u2591\u2591\u2591\u2588\u2588\u2588\u2591     \u2591\u2588\u2588\u2588 \u2591\u2588\u2588\u2588\u2591\u2591\u2591   \u2591\u2588\u2588\u2588       \u2588\u2588\r\n\u2588\u2588\u2588         \u2588\u2588        \u2588\u2588        \u2588\u2588\u2588   \u2591\u2591\u2588\u2588\u2588\u2588\u2588   \u2591\u2591\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588     \u2588\u2588\u2588\u2588\u2588  \u2591\u2588\u2588\u2588      \u2588\u2588\u2588\u2588\u2588\u2591\u2591\u2588\u2588\u2588\u2588\u2588\u2588  \u2588\u2588\u2588\u2588\u2588      \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588    \u2591\u2591\u2591\u2591\u2591     \u2591\u2591\u2591\u2591\u2591\u2591  \u2591\u2591\u2591\u2591\u2591     \u2591\u2591\u2591\u2591\u2591   \u2591\u2588\u2588\u2588     \u2591\u2591\u2591\u2591\u2591  \u2591\u2591\u2591\u2591\u2591\u2591  \u2591\u2591\u2591\u2591\u2591       \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588                                        \u2591\u2588\u2588\u2588                                \u2588\u2588\r\n\u2588\u2588\u2588    \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\r\n```\r\n[![PyPI-Version][version-badge]][version-link] [![PyPI-License][license-badge]](LICENSE)\r\n\r\n\r\n**Pioverifier** is a simple CLI tool that allows you to verify *platformio.ini* config file\r\nfor [PlatformIO](https://platformio.org \"Professional collaborative platform for embedded development\")-based projects.\r\nIt is distributed as a Python package on [PyPI](https://pypi.org \"Python Package Index\").\r\n\r\n## **Package is currently on *planning* stage**\r\n**All the paragraphs below do not reflect the actual functionality for now.**\r\n\r\n## Installation\r\n\r\nInstall and update using [pip](https://pip.pypa.io/en/stable/getting-started \"pip documentation\"):\r\n``` batchfile\r\npip install --upgrade pioverifier\r\n```\r\n\r\n## Usage\r\n\r\nConsidering your project has the following structure:\r\n```\r\nproject-dir\r\n\u251c\u2500\u2500 ... (project dirs and files)\r\n\u2514\u2500\u2500 platformio.ini\r\n```\r\n\r\nrun these commands in a terminal to perform a verification:\r\n``` batchfile\r\ncd path\\to\\project-dir\r\npython -m pioverifier\r\n```\r\n\r\nalternatively, you can run an equivalent one-line command:\r\n``` batchfile\r\npython -m pioverifier --project-path=\"path\\to\\project-dir\"\r\n```\r\n\r\n[version-badge]: https://img.shields.io/pypi/v/pioverifier?style=flat-square\r\n[version-link]:  https://pypi.python.org/pypi/pioverifier\r\n[license-badge]: https://img.shields.io/pypi/l/pioverifier?style=flat-square\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple CLI tool to verify platformio.ini file",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/dakalamin/pioverifier"
    },
    "split_keywords": [
        "cli",
        "embedded",
        "pio",
        "platformio",
        "verification"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f368ce0d18d34d9ae45155d3e8824ccf9a2aad1010a9b629f4cbe6329e78880f",
                "md5": "929c28b61bf2d5cf2fc45427245628ab",
                "sha256": "130d655664f3cb13386db2cbeb9de86509319493b257efde90fea6a406cf3282"
            },
            "downloads": -1,
            "filename": "pioverifier-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "929c28b61bf2d5cf2fc45427245628ab",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 3255,
            "upload_time": "2023-06-27T02:26:26",
            "upload_time_iso_8601": "2023-06-27T02:26:26.618060Z",
            "url": "https://files.pythonhosted.org/packages/f3/68/ce0d18d34d9ae45155d3e8824ccf9a2aad1010a9b629f4cbe6329e78880f/pioverifier-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8841ff98ccdd2cf8a6f555cd904705bfb4869f0883592ab24fab5659d96678b6",
                "md5": "fca3fe61b1ce6a0cc72303988d202a47",
                "sha256": "6f90dbae6d52275e030424f73b25e703263966ccc075689fe213e985c4209d50"
            },
            "downloads": -1,
            "filename": "pioverifier-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fca3fe61b1ce6a0cc72303988d202a47",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 3415,
            "upload_time": "2023-06-27T02:26:29",
            "upload_time_iso_8601": "2023-06-27T02:26:29.027951Z",
            "url": "https://files.pythonhosted.org/packages/88/41/ff98ccdd2cf8a6f555cd904705bfb4869f0883592ab24fab5659d96678b6/pioverifier-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-27 02:26:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dakalamin",
    "github_project": "pioverifier",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "click",
            "specs": []
        },
        {
            "name": "platformio",
            "specs": []
        }
    ],
    "lcname": "pioverifier"
}
        
Elapsed time: 0.08184s