type annotations in python bindings

Author: nleroy917

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "genimtools"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

bindings/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "genimtools-py"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

bindings/README.md

@@ -0,0 +1,16 @@
+# genimtools
+This is a python wrapper around the `genimtools` crate. It provides an easy interface for using `genimtools` in python. It is currently in early development, and as such, it does not have a lot of functionality yet, but new tools are being worked on right now.
+
+## Installation
+You can get `genimtools` from PyPI:
+```bash
+pip install genimtools
+```
+
+## Usage
+Import the package, and use the tools:
+```python
+import genimtools as gt
+
+gt.prune_universe(...)
+```

bindings/genimtools.pyi

@@ -0,0 +1,14 @@
+from typing import Optional
+
+def prune_universe(universe: str, data: str, min_count: Optional[int], output: Optional[str]) -> None:
+    """
+    Prune a universe file.
+
+    Pruning a universe file removes all items that appear less than min_count. This is useful for
+    removing universe regions that are never seen during training or ultra-rare regions.
+
+    :param str universe: Path to the universe file.
+    :param str data: Path to the data (folder of bed files).
+    :param int min_count: Minimum number of times a region must appear to be kept.
+    :param str output: Path to the output file.
+    """

bindings/pyproject.toml

@@ -14,3 +14,6 @@ dynamic = ["version"]
 
 [tool.maturin]
 features = ["pyo3/extension-module"]
+
+[tool.setuptools.dynamic]
+readme = {file = "README.md", content-type = "text/markdown"}

docs/changelog.md

@@ -4,6 +4,9 @@ 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.0.4]
+- add type annotations to the python bindings
+
 ## [0.0.3]
 - work on python bindings initialization