From b2b0ecf0f73760ebef4211afd7d894f4e6030953 Mon Sep 17 00:00:00 2001
From: Martin Milata <martin@martinmilata.cz>
Date: Mon, 19 Apr 2021 16:14:55 +0200
Subject: [PATCH] docs(python): use towncrier for generating CHANGELOG.md

---
 python/.changelog.d/.gitignore       |  1 +
 python/.changelog.d/1167.changed     |  1 +
 python/.changelog.d/1193.added       |  1 +
 python/.changelog.d/1227.added       |  1 +
 python/.changelog.d/1232.fixed       |  1 +
 python/.changelog.d/1257.fixed       |  1 +
 python/.changelog.d/1266.changed     |  1 +
 python/.changelog.d/1363.added       |  1 +
 python/.changelog.d/1496.added       |  1 +
 python/.changelog.d/1531.removed     |  1 +
 python/.changelog.d/379.changed      |  1 +
 python/.changelog.d/379.deprecated.1 |  1 +
 python/.changelog.d/379.deprecated.2 |  1 +
 python/.changelog.d/379.deprecated.3 |  1 +
 python/.changelog.d/810.removed      |  1 +
 python/.towncrier.template.md        |  1 +
 python/CHANGELOG.md                  | 40 --------------------------
 python/towncrier.toml                | 43 ++++++++++++++++++++++++++++
 18 files changed, 59 insertions(+), 40 deletions(-)
 create mode 100644 python/.changelog.d/.gitignore
 create mode 100644 python/.changelog.d/1167.changed
 create mode 100644 python/.changelog.d/1193.added
 create mode 100644 python/.changelog.d/1227.added
 create mode 100644 python/.changelog.d/1232.fixed
 create mode 100644 python/.changelog.d/1257.fixed
 create mode 100644 python/.changelog.d/1266.changed
 create mode 100644 python/.changelog.d/1363.added
 create mode 100644 python/.changelog.d/1496.added
 create mode 100644 python/.changelog.d/1531.removed
 create mode 100644 python/.changelog.d/379.changed
 create mode 100644 python/.changelog.d/379.deprecated.1
 create mode 100644 python/.changelog.d/379.deprecated.2
 create mode 100644 python/.changelog.d/379.deprecated.3
 create mode 100644 python/.changelog.d/810.removed
 create mode 120000 python/.towncrier.template.md
 create mode 100644 python/towncrier.toml

diff --git a/python/.changelog.d/.gitignore b/python/.changelog.d/.gitignore
new file mode 100644
index 000000000..f935021a8
--- /dev/null
+++ b/python/.changelog.d/.gitignore
@@ -0,0 +1 @@
+!.gitignore
diff --git a/python/.changelog.d/1167.changed b/python/.changelog.d/1167.changed
new file mode 100644
index 000000000..425a118a7
--- /dev/null
+++ b/python/.changelog.d/1167.changed
@@ -0,0 +1 @@
+Support long PIN of up to 50 digits.
diff --git a/python/.changelog.d/1193.added b/python/.changelog.d/1193.added
new file mode 100644
index 000000000..1fd7dc149
--- /dev/null
+++ b/python/.changelog.d/1193.added
@@ -0,0 +1 @@
+Support for temporary or permanent `safety-checks` setting
diff --git a/python/.changelog.d/1227.added b/python/.changelog.d/1227.added
new file mode 100644
index 000000000..5032e6ea5
--- /dev/null
+++ b/python/.changelog.d/1227.added
@@ -0,0 +1 @@
+Enabled session management via `EndSession`
diff --git a/python/.changelog.d/1232.fixed b/python/.changelog.d/1232.fixed
new file mode 100644
index 000000000..d3273f250
--- /dev/null
+++ b/python/.changelog.d/1232.fixed
@@ -0,0 +1 @@
+added missing dependency on `attrs`
diff --git a/python/.changelog.d/1257.fixed b/python/.changelog.d/1257.fixed
new file mode 100644
index 000000000..6dbfd2b6b
--- /dev/null
+++ b/python/.changelog.d/1257.fixed
@@ -0,0 +1 @@
+fixed number imprecision in `build_tx.py` that could cause "invalid prevhash" errors
diff --git a/python/.changelog.d/1266.changed b/python/.changelog.d/1266.changed
new file mode 100644
index 000000000..2b4cbc6ad
--- /dev/null
+++ b/python/.changelog.d/1266.changed
@@ -0,0 +1 @@
+`btc.sign_tx()` accepts keyword arguments for transaction metadata
diff --git a/python/.changelog.d/1363.added b/python/.changelog.d/1363.added
new file mode 100644
index 000000000..db40a25d9
--- /dev/null
+++ b/python/.changelog.d/1363.added
@@ -0,0 +1 @@
+Support for Output Descriptors export
diff --git a/python/.changelog.d/1496.added b/python/.changelog.d/1496.added
new file mode 100644
index 000000000..ca8d80ebd
--- /dev/null
+++ b/python/.changelog.d/1496.added
@@ -0,0 +1 @@
+PIN entry via letters
diff --git a/python/.changelog.d/1531.removed b/python/.changelog.d/1531.removed
new file mode 100644
index 000000000..4b4013365
--- /dev/null
+++ b/python/.changelog.d/1531.removed
@@ -0,0 +1 @@
+dropped debug-only `trezorctl debug show-text` functionality
diff --git a/python/.changelog.d/379.changed b/python/.changelog.d/379.changed
new file mode 100644
index 000000000..0ad0518be
--- /dev/null
+++ b/python/.changelog.d/379.changed
@@ -0,0 +1 @@
+protobuf is aware of `required` fields and default values
diff --git a/python/.changelog.d/379.deprecated.1 b/python/.changelog.d/379.deprecated.1
new file mode 100644
index 000000000..026e518e6
--- /dev/null
+++ b/python/.changelog.d/379.deprecated.1
@@ -0,0 +1 @@
+instantiating protobuf objects with positional arguments is deprecated
diff --git a/python/.changelog.d/379.deprecated.2 b/python/.changelog.d/379.deprecated.2
new file mode 100644
index 000000000..633d4f12c
--- /dev/null
+++ b/python/.changelog.d/379.deprecated.2
@@ -0,0 +1 @@
+values of required fields must be supplied at instantiation time. Omitting them is deprecated.
diff --git a/python/.changelog.d/379.deprecated.3 b/python/.changelog.d/379.deprecated.3
new file mode 100644
index 000000000..199e768e1
--- /dev/null
+++ b/python/.changelog.d/379.deprecated.3
@@ -0,0 +1 @@
+`details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead.
diff --git a/python/.changelog.d/810.removed b/python/.changelog.d/810.removed
new file mode 100644
index 000000000..901018f51
--- /dev/null
+++ b/python/.changelog.d/810.removed
@@ -0,0 +1 @@
+dropped Python 3.5 support
diff --git a/python/.towncrier.template.md b/python/.towncrier.template.md
new file mode 120000
index 000000000..ee2d21f96
--- /dev/null
+++ b/python/.towncrier.template.md
@@ -0,0 +1 @@
+../tools/towncrier.template.md
\ No newline at end of file
diff --git a/python/CHANGELOG.md b/python/CHANGELOG.md
index 486576a11..c8ea45c9d 100644
--- a/python/CHANGELOG.md
+++ b/python/CHANGELOG.md
@@ -5,39 +5,6 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.13.0] - Unreleased
-[0.13.0]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.2...master
-
-### Added
-
-- Enabled session management via `EndSession`  [#1227]
-- Support for temporary or permanent `safety-checks` setting
-- Support for Output Descriptors export [#1363]
-- PIN entry via letters  [#1496]
-
-### Changed
-
-- protobuf is aware of `required` fields and default values
-- `btc.sign_tx()` accepts keyword arguments for transaction metadata  [#1266]
-- Support long PIN of up to 50 digits.  [#1167]
-
-### Deprecated
-
-- instantiating protobuf objects with positional arguments is deprecated
-- values of required fields must be supplied at instantiation time. Omitting them is deprecated.
-- `details` argument to `btc.sign_tx()` is deprecated. Use keyword arguments instead.
-
-### Fixed
-
-- added missing dependency on `attrs`  [#1232]
-- fixed number imprecision in `build_tx.py` that could cause "invalid prevhash" errors
-
-### Removed
-
-- dropped Python 3.5 support  [#810]
-- dropped debug-only `trezorctl debug show-text` functionality
-
-
 ## [0.12.2] - 2020-08-27
 [0.12.2]: https://github.com/trezor/trezor-firmware/compare/python/v0.12.1...python/v0.12.2
 
@@ -506,16 +473,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#349]: https://github.com/trezor/python-trezor/issues/349
 [#351]: https://github.com/trezor/python-trezor/issues/351
 [#352]: https://github.com/trezor/python-trezor/issues/352
-[#810]: https://github.com/trezor/trezor-firmware/issues/810
 [#948]: https://github.com/trezor/trezor-firmware/issues/948
 [#1052]: https://github.com/trezor/trezor-firmware/issues/1052
 [#1126]: https://github.com/trezor/trezor-firmware/issues/1126
-[#1167]: https://github.com/trezor/trezor-firmware/issues/1167
 [#1179]: https://github.com/trezor/trezor-firmware/issues/1179
 [#1196]: https://github.com/trezor/trezor-firmware/issues/1196
 [#1210]: https://github.com/trezor/trezor-firmware/issues/1210
-[#1227]: https://github.com/trezor/trezor-firmware/issues/1227
-[#1232]: https://github.com/trezor/trezor-firmware/issues/1232
-[#1266]: https://github.com/trezor/trezor-firmware/issues/1266
-[#1363]: https://github.com/trezor/trezor-firmware/pull/1363
-[#1496]: https://github.com/trezor/trezor-firmware/pull/1496
diff --git a/python/towncrier.toml b/python/towncrier.toml
new file mode 100644
index 000000000..232471cae
--- /dev/null
+++ b/python/towncrier.toml
@@ -0,0 +1,43 @@
+[tool.towncrier]
+directory = ".changelog.d"
+filename = "CHANGELOG.md"
+template = ".towncrier.template.md"
+start_string = "The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)."
+title_format = "\n## [{version}] - {project_date}"
+issue_format = "[#{issue}]"
+underlines = ["", ""]
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "security"
+name = "Security"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "incompatible"
+name = "Incompatible changes"
+showcontent = true