{ "info": { "author": "Tom\u00e1s V\u00edrseda", "author_email": "tomasvirseda@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "Intended Audience :: Other Audience", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Natural Language :: English", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Utilities" ], "description": ".. contents::\n :depth: 3\n..\n\nIntroduction\n============\n\n**KB4IT** helps you to build a static website with all your procedures\nand documents\n\nIt is based on `Asciidoctor `__ markdown.\n\nMain goals:\n\n- Easy to write technical documentation\n- Easy to find documentation\n- Easy to publish documentation\n- Easy to backup/restore documentation\n\nHow it works\n============\n\nThis is the flow:\n\n1. Delete contents of target directory (if any)\n2. Get source documents\n3. Preprocess documents (get metadata)\n4. Process documents in a temporary dir\n5. Compile documents to html with asciidoc\n6. Copy all documents to target path\n7. Copy source docs to target directory\n\nInstallation\n============\n\nFrom source code:\n\n::\n\n python3 setup.py install --user\n\nThen, you should find the main script here:\n\n $HOME/.local/bin/kb4it\n\n\nFrom Pypi:\n\n::\n\n pip3 install kb4it\n\nExecution\n=========\n\nkb4it is a Python3 script. All parameters are optional except the source\ndirectory.\n\nThe most typical usage would be:\n\n::\n\n kb4it -sp /path/to/source/to/asciidocs -tp /var/www/html/repo -v ERROR\n\n\nDisplay help by passing -h as argument:\n\n::\n\n usage: kb4it [-h] -sp SOURCE_PATH [-tp TARGET_PATH] [-log LOGLEVEL]\n [--version]\n\n KB4IT by Tom\u00e1s V\u00edrseda\n\n optional arguments:\n -h, --help show this help message and exit\n -sp SOURCE_PATH, --source-path SOURCE_PATH\n Path for Asciidoc source files.\n -tp TARGET_PATH, --target-path TARGET_PATH\n Path for output files\n -log LOGLEVEL, --log-level LOGLEVEL\n Increase output verbosity\n --version show program's version number and exit\n\nNotes\n=====\n\n- Target directories are created if they do not exist.\n- Source directory is never touched. Source documents are copied to a\n temporary directory\n- Contents on target directory are always deleted before compilation\n\nDownload\n========\n\nGet a copy from SVN repository:\n\n::\n\n svn checkout https://subversion.t00mlabs.net/kb4it/trunk kb4it\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/t00m/KB4IT/archive/master.zip", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/t00m/KB4IT", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "kb4it", "package_url": "https://pypi.org/project/kb4it/", "platform": "any", "project_url": "https://pypi.org/project/kb4it/", "project_urls": { "Download": "https://github.com/t00m/KB4IT/archive/master.zip", "Homepage": "https://github.com/t00m/KB4IT" }, "release_url": "https://pypi.org/project/kb4it/0.6.0.1/", "requires_dist": [ "rdflib" ], "requires_python": "", "summary": "A static website generator based on Asciidoc sources and Asciidoctor processor and publishing toolchain.", "version": "0.6.0.1" }, "last_serial": 5815361, "releases": { "0.6": [ { "comment_text": "", "digests": { "md5": "7663a63a587b2509a7aedd3e8bd7561d", "sha256": "27c065161081b950393a34aa4a92b140671a86b8863c3ffc748955415b967703" }, "downloads": -1, "filename": "kb4it-0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "7663a63a587b2509a7aedd3e8bd7561d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 63531, "upload_time": "2019-09-10T21:28:23", "url": "https://files.pythonhosted.org/packages/5f/31/386247bc1fd8568c8563312650d9d75544e359f5e4576d582fa2f07ab0a4/kb4it-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a0e54b4fcf8fb58f9acce451383cbe98", "sha256": "64c86d4bc170aed3c8d12ec01892cf6e42840945f1f50ae21c724a8dce54f8ae" }, "downloads": -1, "filename": "kb4it-0.6.tar.gz", "has_sig": false, "md5_digest": "a0e54b4fcf8fb58f9acce451383cbe98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27550, "upload_time": "2019-09-10T21:28:25", "url": "https://files.pythonhosted.org/packages/f1/f1/0d95f1664adee4e76bfd4faadb8d9dfba6c69cfb201a2e8a818280f5f508/kb4it-0.6.tar.gz" } ], "0.6.0.1": [ { "comment_text": "", "digests": { "md5": "78242b57b0e2bd9fab0c3e64064b20c9", "sha256": "9c096572de71bc264d6ab344faddad280917502e9506178317672b2cf3da9c8f" }, "downloads": -1, "filename": "kb4it-0.6.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "78242b57b0e2bd9fab0c3e64064b20c9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 1095631, "upload_time": "2019-09-11T14:42:05", "url": "https://files.pythonhosted.org/packages/e3/15/7ece77b8baeba533946685251374548cdeea93aa787e125dfcc910bcb78e/kb4it-0.6.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "db21bc19c93aaebc9645059f406e9644", "sha256": "d4d27b488d3a7939c888f6d81c84ce6a1766f9bbf5e148eb8457d6d9f591a957" }, "downloads": -1, "filename": "kb4it-0.6.0.1.tar.gz", "has_sig": false, "md5_digest": "db21bc19c93aaebc9645059f406e9644", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 544994, "upload_time": "2019-09-11T14:42:08", "url": "https://files.pythonhosted.org/packages/ab/1d/05daa563ced58db03bb9b73dd234151688dc03bb34e35273c8d9d419931e/kb4it-0.6.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "78242b57b0e2bd9fab0c3e64064b20c9", "sha256": "9c096572de71bc264d6ab344faddad280917502e9506178317672b2cf3da9c8f" }, "downloads": -1, "filename": "kb4it-0.6.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "78242b57b0e2bd9fab0c3e64064b20c9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 1095631, "upload_time": "2019-09-11T14:42:05", "url": "https://files.pythonhosted.org/packages/e3/15/7ece77b8baeba533946685251374548cdeea93aa787e125dfcc910bcb78e/kb4it-0.6.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "db21bc19c93aaebc9645059f406e9644", "sha256": "d4d27b488d3a7939c888f6d81c84ce6a1766f9bbf5e148eb8457d6d9f591a957" }, "downloads": -1, "filename": "kb4it-0.6.0.1.tar.gz", "has_sig": false, "md5_digest": "db21bc19c93aaebc9645059f406e9644", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 544994, "upload_time": "2019-09-11T14:42:08", "url": "https://files.pythonhosted.org/packages/ab/1d/05daa563ced58db03bb9b73dd234151688dc03bb34e35273c8d9d419931e/kb4it-0.6.0.1.tar.gz" } ] }