{ "info": { "author": "Artemy Lomov", "author_email": "artemy@lomov.ru", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "# RunCommands\n\nRunCommands is a preprocessor that allows to execute a sequence of arbitrary external commands.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.runcommands\n```\n\n## Usage\n\nTo enable the preprocessor, add `runcommands` to `preprocessors` section in the project config, and specify the commands to run:\n\n```yaml\npreprocessors:\n - runcommands:\n commands:\n - ./build.sh\n - echo \"Hello World\" > ${WORKING_DIR}/hello.txt\n targets:\n - pre\n - tex\n - pdf\n - docx\n```\n\n`commands`\n: Sequence of system commands to execute one after the other.\n\n`targets`\n: Allowed targets for the preprocessor. If not specified (by default), the preprocessor applies to all targets.\n\n### Supported environment variables\n\nYou may use the following environment variables in your commands:\n\n* `${PROJECT_DIR}` \u2014 full path to the project directory, e.g. `/usr/src/app`;\n* `${SRC_DIR}` \u2014 full path to the directory that contains Markdown sources, e.g. `/usr/src/app/src`;\n* `${WORKING_DIR}` \u2014 full path to the temporary directory that is used by preprocessors, e.g. `/usr/src/app/__folianttmp__`;\n* `${BACKEND}` \u2014 currently used backend, e.g. `pre`, `pandoc`, or `mkdocs`;\n* `${TARGET}` \u2014 current target, e.g. `site`, or `pdf`.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/foliant-docs/foliantcontrib.runcommands", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "foliantcontrib.runcommands", "package_url": "https://pypi.org/project/foliantcontrib.runcommands/", "platform": "any", "project_url": "https://pypi.org/project/foliantcontrib.runcommands/", "project_urls": { "Homepage": "https://github.com/foliant-docs/foliantcontrib.runcommands" }, "release_url": "https://pypi.org/project/foliantcontrib.runcommands/1.0.1/", "requires_dist": [ "foliant (>=1.0.4)" ], "requires_python": "", "summary": "Preprocessor for Foliant to run arbitrary external commands.", "version": "1.0.1" }, "last_serial": 5759630, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "de71372d0dc6a59d61af612338ff5124", "sha256": "8089268f0287c22a32150903810a1ab624ddc853ca23573780f0b9d1494fe237" }, "downloads": -1, "filename": "foliantcontrib.runcommands-1.0.0.tar.gz", "has_sig": false, "md5_digest": "de71372d0dc6a59d61af612338ff5124", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2664, "upload_time": "2018-04-20T17:14:48", "url": "https://files.pythonhosted.org/packages/ac/8e/c453b67d9498deed88609ef7ee7a54d6ae140a1813a75f43d12e8f24b476/foliantcontrib.runcommands-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "5c3a7b233412030f6ee0f4c4a17e78d8", "sha256": "daf6de0c4fb576039b6de93843b2e3e964dbf7c0056667fa894732f8d045db25" }, "downloads": -1, "filename": "foliantcontrib.runcommands-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5c3a7b233412030f6ee0f4c4a17e78d8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3836, "upload_time": "2019-07-15T12:37:28", "url": "https://files.pythonhosted.org/packages/e5/9b/22d7e92133809a358571f7dffcde2858aec0894af899f653e83fce06bfc2/foliantcontrib.runcommands-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27791685b803f42331a57e8a4f9fa0db", "sha256": "562a95f1bc5404cf6238dcf44ef84bf212d0da455b9d180db44541529868b5da" }, "downloads": -1, "filename": "foliantcontrib.runcommands-1.0.1.tar.gz", "has_sig": false, "md5_digest": "27791685b803f42331a57e8a4f9fa0db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2689, "upload_time": "2019-07-15T12:37:30", "url": "https://files.pythonhosted.org/packages/5a/44/d0da6d9721a47af9e51ed5e29a373217d6d0419e740c5793df8e5f97ac8c/foliantcontrib.runcommands-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5c3a7b233412030f6ee0f4c4a17e78d8", "sha256": "daf6de0c4fb576039b6de93843b2e3e964dbf7c0056667fa894732f8d045db25" }, "downloads": -1, "filename": "foliantcontrib.runcommands-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5c3a7b233412030f6ee0f4c4a17e78d8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3836, "upload_time": "2019-07-15T12:37:28", "url": "https://files.pythonhosted.org/packages/e5/9b/22d7e92133809a358571f7dffcde2858aec0894af899f653e83fce06bfc2/foliantcontrib.runcommands-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "27791685b803f42331a57e8a4f9fa0db", "sha256": "562a95f1bc5404cf6238dcf44ef84bf212d0da455b9d180db44541529868b5da" }, "downloads": -1, "filename": "foliantcontrib.runcommands-1.0.1.tar.gz", "has_sig": false, "md5_digest": "27791685b803f42331a57e8a4f9fa0db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2689, "upload_time": "2019-07-15T12:37:30", "url": "https://files.pythonhosted.org/packages/5a/44/d0da6d9721a47af9e51ed5e29a373217d6d0419e740c5793df8e5f97ac8c/foliantcontrib.runcommands-1.0.1.tar.gz" } ] }