pathvalidate-cli


Namepathvalidate-cli JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/thombashi/pathvalidate-cli
Summarypathvalidate-cli is a command line interface for pathvalidate library.
upload_time2023-09-17 09:45:07
maintainer
docs_urlNone
authorTsuyoshi Hombashi
requires_python>=3.8
licenseMIT License
keywords file path validate sanitize
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. contents:: **pathvalidate-cli**
   :backlinks: top
   :depth: 2


Summary
============================================

pathvalidate-cli is a command line interface for `pathvalidate <https://github.com/thombashi/pathvalidate>`__ library.


Installation
============================================
::

    pip install pathvalidate-cli


Usage
============================================

::

    $ pathvalidate sanitize 'fi:l*e/p"a?t>h|.t<xt'
    file/path.txt
    $ pathvalidate --filename sanitize 'fi:l*e/p"a?t>h|.t<xt'
    filepath.txt

    $ pathvalidate validate 'fi:l*e/p"a?t>h|.t<xt'
    [PV1100] invalid characters found: invalids=(':', '*', '"', '?', '>', '|', '<'), value='fi:l*e/p"a?t>h|.t<xt', platform=Windows

Command Help
--------------------------------------------

::

    Usage: pathvalidate [OPTIONS] COMMAND [ARGS]...

    Options:
      --version                     Show the version and exit.
      --debug                       For debug print.
      -q, --quiet                   Suppress execution log messages.
      --filename                    Consider inputs as filenames.
      --max-len, --max-bytes BYTES  Maximum byte counts of file paths. -1: same
                                    value with the platform limitation.  [default:
                                    -1]
      --platform PLATFORM           Execution platform name (case-insensitive).
                                    Valid platform specifiers are
                                    Linux/Windows/macOS. Valid special values are:
                                    POSIX, universal (a) auto: automatically
                                    detects the execution platform. (b) universal:
                                    platform independent.  [default: universal]
      -v, --verbose                 Verbosity level  [default: 0]
      -h, --help                    Show this message and exit.

    Commands:
      error     Print error reasons.
      sanitize  Sanitize file paths.
      validate  Validate file paths.


Dependencies
============================================
Python 3.8+

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/thombashi/pathvalidate-cli",
    "name": "pathvalidate-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "file,path,validate,sanitize",
    "author": "Tsuyoshi Hombashi",
    "author_email": "tsuyoshi.hombashi@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9e/ca/2802c4b9a7375164921a7ca6d12922994d91ec0c5cf0cd4880b32768a27a/pathvalidate-cli-0.0.1.tar.gz",
    "platform": null,
    "description": ".. contents:: **pathvalidate-cli**\n   :backlinks: top\n   :depth: 2\n\n\nSummary\n============================================\n\npathvalidate-cli is a command line interface for `pathvalidate <https://github.com/thombashi/pathvalidate>`__ library.\n\n\nInstallation\n============================================\n::\n\n    pip install pathvalidate-cli\n\n\nUsage\n============================================\n\n::\n\n    $ pathvalidate sanitize 'fi:l*e/p\"a?t>h|.t<xt'\n    file/path.txt\n    $ pathvalidate --filename sanitize 'fi:l*e/p\"a?t>h|.t<xt'\n    filepath.txt\n\n    $ pathvalidate validate 'fi:l*e/p\"a?t>h|.t<xt'\n    [PV1100] invalid characters found: invalids=(':', '*', '\"', '?', '>', '|', '<'), value='fi:l*e/p\"a?t>h|.t<xt', platform=Windows\n\nCommand Help\n--------------------------------------------\n\n::\n\n    Usage: pathvalidate [OPTIONS] COMMAND [ARGS]...\n\n    Options:\n      --version                     Show the version and exit.\n      --debug                       For debug print.\n      -q, --quiet                   Suppress execution log messages.\n      --filename                    Consider inputs as filenames.\n      --max-len, --max-bytes BYTES  Maximum byte counts of file paths. -1: same\n                                    value with the platform limitation.  [default:\n                                    -1]\n      --platform PLATFORM           Execution platform name (case-insensitive).\n                                    Valid platform specifiers are\n                                    Linux/Windows/macOS. Valid special values are:\n                                    POSIX, universal (a) auto: automatically\n                                    detects the execution platform. (b) universal:\n                                    platform independent.  [default: universal]\n      -v, --verbose                 Verbosity level  [default: 0]\n      -h, --help                    Show this message and exit.\n\n    Commands:\n      error     Print error reasons.\n      sanitize  Sanitize file paths.\n      validate  Validate file paths.\n\n\nDependencies\n============================================\nPython 3.8+\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "pathvalidate-cli is a command line interface for pathvalidate library.",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/thombashi/pathvalidate-cli",
        "Source": "https://github.com/thombashi/pathvalidate-cli",
        "Tracker": "https://github.com/thombashi/pathvalidate-cli/issues"
    },
    "split_keywords": [
        "file",
        "path",
        "validate",
        "sanitize"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "19815ca0e5688faa307599ac4ce0847aa6868931af869339f7cecd11366d533d",
                "md5": "a8cdf7d06635be4c31ebe035d66a54a2",
                "sha256": "1e9e5d8d8470ed0a8a99b0ff51e996baf8ca82ffd6e7bdc1cadf8d45414db1b8"
            },
            "downloads": -1,
            "filename": "pathvalidate_cli-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a8cdf7d06635be4c31ebe035d66a54a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7356,
            "upload_time": "2023-09-17T09:45:05",
            "upload_time_iso_8601": "2023-09-17T09:45:05.747939Z",
            "url": "https://files.pythonhosted.org/packages/19/81/5ca0e5688faa307599ac4ce0847aa6868931af869339f7cecd11366d533d/pathvalidate_cli-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9eca2802c4b9a7375164921a7ca6d12922994d91ec0c5cf0cd4880b32768a27a",
                "md5": "693771ccc14fe711f00a5e04a3095ce6",
                "sha256": "d08a3b61946abc4ea3ddfa9b572fe69e129b68a2d56d99db52dc9f1800a0a104"
            },
            "downloads": -1,
            "filename": "pathvalidate-cli-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "693771ccc14fe711f00a5e04a3095ce6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8211,
            "upload_time": "2023-09-17T09:45:07",
            "upload_time_iso_8601": "2023-09-17T09:45:07.856855Z",
            "url": "https://files.pythonhosted.org/packages/9e/ca/2802c4b9a7375164921a7ca6d12922994d91ec0c5cf0cd4880b32768a27a/pathvalidate-cli-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-17 09:45:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "thombashi",
    "github_project": "pathvalidate-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "pathvalidate-cli"
}
        
Elapsed time: 0.13010s