{ "info": { "author": "Roang_zero1", "author_email": "lucas@brandstaetter.tech", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Factorio Changelog Creator\n\nThis is a quick and dirty python script for generating changelog for Factorio mods in various formats.\n\n## Quick install\n\nInstall latest version from PYPI\n\n```code:: bash\npip install factorio-changelog-creator\n```\n\nInstall the current dev version from _GitHub_\n\n```code:: bash\npip install git+https://github.com/Roang-zero1/factorio-changelog-creator.git\n```\n\n## Usage\n\nGet the script file and put it somewhere on your computer.\n\nRun the script from the command line using `factorio-changelog-creator`. If no parameters are given, it will look for a file named `changelog.json` in the directory it was called from and it will output into the same directory.\n\nThere is a command line help available, which can be outputted with `factorio-changelog-creator -h`.\n\n```text\nusage: factorio-changelog-creator [-h]\n [-f {md,ingame,forum} [{md,ingame,forum} ...]]\n [-v]\n [output_dir] [input_file]\n\nFactorio changelog generator\n\npositional arguments:\n output_dir Directory where the files will be written\n input_file JSON file to parse for changes\n\noptional arguments:\n -h, --help show this help message and exit\n -f {md,ingame,forum} [{md,ingame,forum} ...], --formats {md,ingame,forum} [{md,ingame,forum} ...]\n Which format[s] should be generated\n -v, --verbose Output verbosity\n```\n\nBy default the markdown and in-game changelog will be generated. The forum changelog can be generated with `python3 changelog-script.py -f forum`.\n\n- `changelog_forum.txt`: The syntax forums.factorio.com uses\n- `CHANGELOG.md`: A markdown syntax that should work both on mods.factorio.com and GitHub\n- `changelog.txt`: The syntax the game uses - this is what should be left in the mod\n\n## Format\n\nThe changelog definition file should be a JSON file containing a dictionary of version dictionaries.\n\nThe format of the dictionary is this:\n\n```json\n{\n \"0.1.0\": {\n \"date\": \"2019-06-08\", -- Optional, can be anything\n\n \"Changes\": [\"Change without category\"], --Changes will be put in the Oterh Category\n\n \"Categories\": { -- Categories may be any string\n \"Features\": [\"Change in category\"]\n }\n }\n}\n```\n\nChanges can be declared as simple strings, or as a table in the following format:\n\n```json\n{\n \"change\": \"Change description\", -- Mandatory\n \"more\": \"https://link.to.nowhere.com\", -- Optional\n \"by\": \"Name\", -- Optional\n}\n```\n\n`more` and `by` work in the same way, but have different meanings: `more` is a link with more information and `by` is\nthe author of the change.\nThey can be either a single entry or a list of entries, the list will be outputted comma-separated.\nEach entry may either be a plain string that will be directly used or a dictionary with a single entry in the format:\n\n```json\n{\n \"url_text\": \"url_target\"\n}\n```\n\nDepending on the format either a link will be generated of if this in not possible `more` will use the `url_target` value and `by` will use the `url_text`.\n\n## Acknowledgement\n\nInitial Lua implementation by theRustyKnife/factorio-changelog-script\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/Roang-zero1/factorio-changelog-creator", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "factorio-changelog-creator", "package_url": "https://pypi.org/project/factorio-changelog-creator/", "platform": "", "project_url": "https://pypi.org/project/factorio-changelog-creator/", "project_urls": { "Homepage": "https://github.com/Roang-zero1/factorio-changelog-creator" }, "release_url": "https://pypi.org/project/factorio-changelog-creator/1.1.1/", "requires_dist": null, "requires_python": "", "summary": "A script to generate multiple factorio changelog formats.", "version": "1.1.1" }, "last_serial": 5376204, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "33081b6265d476881bcd824a0dd06787", "sha256": "6df1c1257985475b0ed35af0741631210920697716dbf5f1c7efd8b140dc9e55" }, "downloads": -1, "filename": "factorio_changelog_creator-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "33081b6265d476881bcd824a0dd06787", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6623, "upload_time": "2019-06-08T16:47:41", "url": "https://files.pythonhosted.org/packages/6a/5a/3b368a0af665f6c785de17513363f316c7c6edbdbce2f040d7dc81a8f131/factorio_changelog_creator-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fa505774ad22a7efc64852b1db8f451a", "sha256": "b617bf3c83b00eb87ade17e56dc47c14339fa8602641cc3f6a83dffb471b11fd" }, "downloads": -1, "filename": "factorio-changelog-creator-1.0.1.tar.gz", "has_sig": false, "md5_digest": "fa505774ad22a7efc64852b1db8f451a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4384, "upload_time": "2019-06-08T16:47:42", "url": "https://files.pythonhosted.org/packages/6e/87/bc4f574ef05525855fb3ba85cc82726ae10f4b5ecc6c37d0fde43dd4aab0/factorio-changelog-creator-1.0.1.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "99e46857d7d09a810918d445d9523434", "sha256": "1cc0f2c79ef795b42b327f03a9e89ebcb509b3c535cf34df584fb0e7492ab144" }, "downloads": -1, "filename": "factorio_changelog_creator-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "99e46857d7d09a810918d445d9523434", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6691, "upload_time": "2019-06-08T21:25:02", "url": "https://files.pythonhosted.org/packages/06/4b/071f5cf99b5234f17734ed96179bb1e356bbaaab2d459b90208fdeaf6d46/factorio_changelog_creator-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1edcc6fc3e8c16291f7fd1a3af802b89", "sha256": "4ac7795257a3f6486710ea4a407fcc187c36d8b9803c29ec51b767b402248f08" }, "downloads": -1, "filename": "factorio-changelog-creator-1.1.1.tar.gz", "has_sig": false, "md5_digest": "1edcc6fc3e8c16291f7fd1a3af802b89", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4499, "upload_time": "2019-06-08T21:25:04", "url": "https://files.pythonhosted.org/packages/fd/ea/c090a489e53267e983e1807a84ba255a7c2a9d280223a83640754b334e9a/factorio-changelog-creator-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "99e46857d7d09a810918d445d9523434", "sha256": "1cc0f2c79ef795b42b327f03a9e89ebcb509b3c535cf34df584fb0e7492ab144" }, "downloads": -1, "filename": "factorio_changelog_creator-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "99e46857d7d09a810918d445d9523434", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6691, "upload_time": "2019-06-08T21:25:02", "url": "https://files.pythonhosted.org/packages/06/4b/071f5cf99b5234f17734ed96179bb1e356bbaaab2d459b90208fdeaf6d46/factorio_changelog_creator-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1edcc6fc3e8c16291f7fd1a3af802b89", "sha256": "4ac7795257a3f6486710ea4a407fcc187c36d8b9803c29ec51b767b402248f08" }, "downloads": -1, "filename": "factorio-changelog-creator-1.1.1.tar.gz", "has_sig": false, "md5_digest": "1edcc6fc3e8c16291f7fd1a3af802b89", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4499, "upload_time": "2019-06-08T21:25:04", "url": "https://files.pythonhosted.org/packages/fd/ea/c090a489e53267e983e1807a84ba255a7c2a9d280223a83640754b334e9a/factorio-changelog-creator-1.1.1.tar.gz" } ] }