Add typing support to ofrak_ghidra package (#421)

* Add typing to ofrak_ghidra package * Add changelog --------- Co-authored-by: Paul Noalhyt <[email protected]>
redballoonsecurity · Feb 17, 2024 · fd7fc5d · fd7fc5d
1 parent e001c49
commit fd7fc5d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/disassemblers/ofrak_ghidra/CHANGELOG.md b/disassemblers/ofrak_ghidra/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to `ofrak-ghidra` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/redballoonsecurity/ofrak/tree/master)
+
+## 0.1.1 - 2024-02-15
+### Added
+- Added typing support to the ofrak-ghidra package. This is helpful for users who use `mypy` and `ofrak_ghidra` in a project.
+
+## 0.1.0 - 2022-08-09
+### Added
+Initial release. Hello world!
diff --git a/disassemblers/ofrak_ghidra/ofrak_ghidra/py.typed b/disassemblers/ofrak_ghidra/ofrak_ghidra/py.typed
diff --git a/disassemblers/ofrak_ghidra/setup.py b/disassemblers/ofrak_ghidra/setup.py
@@ -37,6 +37,7 @@ def read_requirements(requirements_path):
     description="OFRAK Ghidra Components",
     url="",  # TODO
     packages=setuptools.find_packages(),
+    package_data={"ofrak_ghidra": ["py.typed"]},
     classifiers=[
         "Programming Language :: Python :: 3",
         "Operating System :: OS Independent",