OctoPrint-FileCheck


NameOctoPrint-FileCheck JSON
Version 2024.11.12 PyPI version JSON
download
home_pagehttps://github.com/OctoPrint/OctoPrint-FileCheck
SummaryChecks for common issues in uploaded files
upload_time2024-11-12 13:59:19
maintainerNone
docs_urlNone
authorGina Häußge
requires_pythonNone
licenseAGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # File Check

The File Check plugin tries to detect common issues in uploaded files that are known to cause
issues while printing and which in the past have caused support requests on OctoPrint's Community
Forums, as well as leaked sensitive data such as API keys.

![Screenshot](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FileCheck/master/extras/screenshot.png)

It currently detects and warns about the following issues:

  * Outdated placeholder `{travel_speed}` left in the GCODE generated by the slicer. See
    [here](https://faq.octoprint.org/file-check-travel-speed) for details on this.
  * API keys leaked by the slicer into the GCODE. See
    [here](https://faq.octoprint.org/file-check-leaked-api-key) for details on this.

Since version 2024.3.27 it also supports checking selected files as well as all uploaded files for issues on
the press of a button (if `grep` is available), not just freshly uploaded files.

## Setup

The plugin is part of the core dependencies of OctoPrint 1.4.1+ and will be installed automatically alongside it.

In case you want to manually install it for whatever reason, install via the bundled
[Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
or manually using this URL:

    https://github.com/OctoPrint/OctoPrint-FileCheck/archive/master.zip



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/OctoPrint/OctoPrint-FileCheck",
    "name": "OctoPrint-FileCheck",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Gina H\u00e4u\u00dfge",
    "author_email": "gina@octoprint.org",
    "download_url": "https://files.pythonhosted.org/packages/00/47/11b264b46b7de18a3c383e406fe3c55bfb73c6c62d28af8d29c954d34f90/OctoPrint-FileCheck-2024.11.12.tar.gz",
    "platform": null,
    "description": "# File Check\n\nThe File Check plugin tries to detect common issues in uploaded files that are known to cause\nissues while printing and which in the past have caused support requests on OctoPrint's Community\nForums, as well as leaked sensitive data such as API keys.\n\n![Screenshot](https://raw.githubusercontent.com/OctoPrint/OctoPrint-FileCheck/master/extras/screenshot.png)\n\nIt currently detects and warns about the following issues:\n\n  * Outdated placeholder `{travel_speed}` left in the GCODE generated by the slicer. See\n    [here](https://faq.octoprint.org/file-check-travel-speed) for details on this.\n  * API keys leaked by the slicer into the GCODE. See\n    [here](https://faq.octoprint.org/file-check-leaked-api-key) for details on this.\n\nSince version 2024.3.27 it also supports checking selected files as well as all uploaded files for issues on\nthe press of a button (if `grep` is available), not just freshly uploaded files.\n\n## Setup\n\nThe plugin is part of the core dependencies of OctoPrint 1.4.1+ and will be installed automatically alongside it.\n\nIn case you want to manually install it for whatever reason, install via the bundled\n[Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)\nor manually using this URL:\n\n    https://github.com/OctoPrint/OctoPrint-FileCheck/archive/master.zip\n\n\n",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "Checks for common issues in uploaded files",
    "version": "2024.11.12",
    "project_urls": {
        "Homepage": "https://github.com/OctoPrint/OctoPrint-FileCheck"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4afcc15cc24dccab487b570f9ec9257feca94e7d3633b203fbfd9d3668542571",
                "md5": "944b8e825a2406376916b0f311504cde",
                "sha256": "d97c0bfd4cd6f70e73a8d1203924829d0e52b06c7e75368d836b59fa4d48e94f"
            },
            "downloads": -1,
            "filename": "OctoPrint_FileCheck-2024.11.12-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "944b8e825a2406376916b0f311504cde",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 31402,
            "upload_time": "2024-11-12T13:59:18",
            "upload_time_iso_8601": "2024-11-12T13:59:18.054764Z",
            "url": "https://files.pythonhosted.org/packages/4a/fc/c15cc24dccab487b570f9ec9257feca94e7d3633b203fbfd9d3668542571/OctoPrint_FileCheck-2024.11.12-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "004711b264b46b7de18a3c383e406fe3c55bfb73c6c62d28af8d29c954d34f90",
                "md5": "9f07da1a4dae6ccbbbf7d3f52a307af9",
                "sha256": "21e258a5a6b3cc74e6256616731e0bd732abf18d59e78ba92b929ed3f1194169"
            },
            "downloads": -1,
            "filename": "OctoPrint-FileCheck-2024.11.12.tar.gz",
            "has_sig": false,
            "md5_digest": "9f07da1a4dae6ccbbbf7d3f52a307af9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 31494,
            "upload_time": "2024-11-12T13:59:19",
            "upload_time_iso_8601": "2024-11-12T13:59:19.762029Z",
            "url": "https://files.pythonhosted.org/packages/00/47/11b264b46b7de18a3c383e406fe3c55bfb73c6c62d28af8d29c954d34f90/OctoPrint-FileCheck-2024.11.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 13:59:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OctoPrint",
    "github_project": "OctoPrint-FileCheck",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "octoprint-filecheck"
}
        
Elapsed time: 0.42080s