mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-04-12 15:27:14 +03:00
108 lines
4.2 KiB
Python
108 lines
4.2 KiB
Python
#!/usr/bin/env python3
|
|
# flake8: noqa
|
|
"""
|
|
build_changelog.py - Read the latest changelog file and format for the Forums and Reddit.
|
|
|
|
Copyright (c) EDCD, All Rights Reserved
|
|
Licensed under the GNU General Public License.
|
|
See LICENSE file.
|
|
"""
|
|
import pathlib
|
|
import re
|
|
from os import chdir
|
|
import mistune
|
|
|
|
|
|
def get_changelog() -> str:
|
|
"""Pull the last full changelog details in MD."""
|
|
with open("../CHANGELOG.md", encoding="utf-8") as changelog_file:
|
|
content = changelog_file.read()
|
|
changelog_list: list = content.split("---", maxsplit=2)
|
|
changelog = changelog_list[2]
|
|
changelog_list = changelog.split("===", maxsplit=2)
|
|
changelog_list[0] = changelog_list[0].rstrip()
|
|
changelog_list[0] = changelog_list[0].lstrip()
|
|
changelog_list[0] += "\n==="
|
|
changelog_list[1] = changelog_list[1].rstrip()
|
|
changelog_list[1] = "\n".join(changelog_list[1].split("\n")[:-2])
|
|
changelog = changelog_list[0] + changelog_list[1]
|
|
changelog = changelog.rstrip()
|
|
return changelog
|
|
|
|
|
|
def build_html(md_changelog) -> None:
|
|
html_out = mistune.html(md_changelog)
|
|
html_out = re.sub("h1", "h2", html_out)
|
|
html_out += "\n<hr>"
|
|
with open("script_output/html_changelog.txt", "w", encoding="utf-8") as html_file:
|
|
html_file.write(html_out)
|
|
|
|
|
|
def build_reddit(
|
|
md_changelog: str, vt_signed: str, vt_unsigned: str, version: str, gh_link: str
|
|
) -> None:
|
|
reddit_start = """# What Is Elite Dangerous Market Connector?
|
|
|
|
Elite Dangerous Market Connector ("EDMC") is a third-party application for use with Frontier Developments' game "Elite Dangerous". Its purpose is to facilitate supplying certain game data to, and in some cases retrieving it from, a number of websites and other tools.
|
|
|
|
To achieve this it utilizes the Journal Files written by the game when played on a PC. It also makes use of Frontier's Companion API ("Frontier's CAPI"), accessible once you've authorized this application.
|
|
|
|
EDMC has a plugin system that many other developers have made use of to extend its functionality.
|
|
|
|
Find out more on the [EDMC Wiki](https://github.com/EDCD/EDMarketConnector/wiki).
|
|
|
|
~~----------------------------------------------------~~
|
|
|
|
You can also view the Elite: Dangerous Forum thread [HERE](https://forums.frontier.co.uk/threads/elite-dangerous-market-connector-edmc.618708/).
|
|
|
|
~~----------------------------------------------------~~
|
|
|
|
**As has become routine now, various anti-virus software are reporting a false positive on our installer and/or files it contains. We've pre-emptively uploaded the installer to** [VirusTotal](
|
|
"""
|
|
reddit_mid_1 = """) **if you want to check what it's saying. Please see our** [Troubleshooting/AV-false-positives FAQ](https://github.com/EDCD/EDMarketConnector/wiki/Troubleshooting#installer-and-or-executables-flagged-as-malicious-viruses) **for further information.**
|
|
|
|
[Unsigned Installer]("""
|
|
|
|
reddit_mid_2 = """) if you don't want to use the code-signed option.
|
|
|
|
~~----------------------------------------------------~~
|
|
"""
|
|
versionsearch = f"Release {version}"
|
|
updated = f"# [Release {version}]({gh_link})"
|
|
md_changelog = re.sub("===\n", "", md_changelog)
|
|
md_changelog = re.sub(versionsearch, updated, md_changelog)
|
|
reddit_end = f"""
|
|
|
|
**Linux**
|
|
|
|
If you're running on Linux, try the [Flatpak](https://flathub.org/apps/io.edcd.EDMarketConnector) build of EDMC! (Update to {version} coming soon.)"""
|
|
|
|
reddit_out = (
|
|
reddit_start
|
|
+ vt_signed
|
|
+ reddit_mid_1
|
|
+ vt_unsigned
|
|
+ reddit_mid_2
|
|
+ md_changelog
|
|
+ reddit_end
|
|
)
|
|
with open(
|
|
"script_output/reddit_changelog.txt", "w", encoding="utf-8"
|
|
) as reddit_file:
|
|
reddit_file.write(reddit_out)
|
|
|
|
|
|
def main() -> None:
|
|
vt_signed = input("Please enter the VirusTotal URL for the Signed Installer: ")
|
|
vt_unsigned = input("Please enter the VirusTotal URL for the Unsigned Installer: ")
|
|
version = input("Please enter the version of EDMC: ")
|
|
gh_link = input(f"Please enter the GitHub link for {version}: ")
|
|
md_changelog = get_changelog()
|
|
build_reddit(md_changelog, vt_signed, vt_unsigned, version, gh_link)
|
|
build_html(md_changelog)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
chdir(pathlib.Path(__file__).parent)
|
|
main()
|