Add type annotations to public function

trendels · May 7, 2021 · c9e15d4 · c9e15d4
1 parent 1727ba7
commit c9e15d4
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 4 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1 +1,3 @@
 include CHANGELOG.md README.* LICENSE Makefile test_braceexpand.py
+include src/braceexpand/*.pyi
+include src/braceexpand/py.typed
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@ README.rst: README.md
 	pandoc --from=markdown --to=rst $< > $@
 
 test:
-	python braceexpand.py
+	python src/braceexpand/__init__.py
 	python test_braceexpand.py
 
 .PHONY: test
diff --git a/setup.py b/setup.py
@@ -1,8 +1,9 @@
+import os
 import re
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
-with open('braceexpand.py') as f:
+with open(os.path.join('src', 'braceexpand', '__init__.py')) as f:
     version = re.findall(r"^__version__ = '(.*)'", f.read(), re.M)[0]
 
 with open('README.rst') as f:
@@ -13,7 +14,6 @@
     version=version,
     author='Stanis Trendelenburg',
     author_email='stanis.trendelenburg@gmail.com',
-    py_modules=['braceexpand'],
     url='https://github.com/trendels/braceexpand',
     license='MIT',
     description='Bash-style brace expansion for Python',
@@ -24,4 +24,7 @@
         'Programming Language :: Python :: 2',
         'Programming Language :: Python :: 3',
     ],
+    package_dir={'': 'src'},
+    packages=find_packages('src'),
+    include_package_data=True,
 )
diff --git a/braceexpand.py → src/braceexpand/__init__.py b/braceexpand.py → src/braceexpand/__init__.py
diff --git a/src/braceexpand/__init__.pyi b/src/braceexpand/__init__.pyi
@@ -0,0 +1,6 @@
+from typing import Iterator
+
+alphabet: str
+
+def braceexpand(pattern: str, escape: bool = ...) -> Iterator[str]: ...
+
diff --git a/src/braceexpand/py.typed b/src/braceexpand/py.typed