prebuild.py

"""
This script generates files required for source and wheel distributions.
"""

import argparse
import sys


def generate_readme() -> None:
	"""
	Generate the "README.rst" file from "README.rst.in".
	"""
	print("Read: README.rst.in")
	with open("README.rst.in", 'r', encoding='utf8') as fh:
		readme = fh.read()

	for old, new in [
		(":class:`dict`", "*dict*"),
		(":class:`tuple`", "*tuple*"),
		(":class:`.SQLParams`", "`SQLParams`_"),
		(":meth:`.SQLParams.format`", "`SQLParams.format`_"),
		(":meth:`.SQLParams.formatmany`", "`SQLParams.formatmany`_"),
		(":mod:`sqlparams`", "*sqlparams*"),
	]:
		readme = readme.replace(old, new)

	readme += "\n"
	readme += ".. _`SQLParams`: https://python-sql-parameters.readthedocs.io/en/latest/sqlparams.html#sqlparams.SQLParams\n"
	readme += ".. _`SQLParams.format`: https://python-sql-parameters.readthedocs.io/en/latest/sqlparams.html#sqlparams.SQLParams.format\n"
	readme += ".. _`SQLParams.formatmany`: https://python-sql-parameters.readthedocs.io/en/latest/sqlparams.html#sqlparams.SQLParams.formatmany\n"

	print("Write: README.rst")
	with open("README.rst", 'w', encoding='UTF-8') as fh:
		fh.write(readme)


def generate_readme_dist() -> None:
	"""
	Generate the "README-dist.rst" file from "README.rst" and
	"CHANGES.rst".
	"""
	print("Read: README.rst")
	with open("README.rst", 'r', encoding='utf8') as fh:
		output = fh.read()

	print("Read: CHANGES.rst")
	with open("CHANGES.rst", 'r', encoding='utf8') as fh:
		output += "\n\n"
		output += fh.read()

	print("Write: README-dist.rst")
	with open("README-dist.rst", 'w', encoding='utf8') as fh:
		fh.write(output)


def main() -> int:
	"""
	Run the script.
	"""
	# Parse command-line arguments.
	parser = argparse.ArgumentParser(description=__doc__)
	parser.parse_args(sys.argv[1:])

	generate_readme()
	generate_readme_dist()

	return 0


if __name__ == '__main__':
	sys.exit(main())