Add contribution instructions in CONTRIBUTING.md

Author: althonos

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to `iocursor`
+
+For bug fixes or new features, please file an issue before submitting a
+pull request. If the change isn't trivial, it may be best to wait for
+feedback.
+
+## Running tests
+
+Tests are written as usual Python unit tests with the `unittest` module of
+the standard library. Running them requires the extension to be built
+locally:
+
+```console
+$ python setup.py build_ext --debug --inplace
+$ python -m unittest discover -vv
+```
+
+## Coding guidelines
+
+This project targets Python 3.5 or later.
+
+Python objects should be typed; since it is not supported in C extensions,
+you must manually declare types in type stubs (`.pyi` files). In Python
+files, you can add type annotations to function signatures (supported in
+Python 3.5), but not in variable assignments (supported only from Python 3.6
+onward).
+
+### Interfacing with C
+
+When interfacing with C, and in particular with pointers, try to use
+debug assertions everywhere you assume the pointer to be non-NULL.

MANIFEST.in

@@ -1,5 +1,6 @@
 include COPYING
 include CHANGELOG.md
+include CONTRIBUTING.md
 include iocursor/cursor.c
 include iocursor/cursor.h
 include iocursor/py.typed

README.md

@@ -42,6 +42,9 @@ Install directly from PyPI, using [pip](https://pip.pypa.io/):
 $ pip install iocursor
 ```
 
+Pre-built wheels are available on Linux and OSX for all supported Python3
+versions. Otherwise, building from source only requires a working C compiler.
+
 
 ## 🧶 Thread-safety
 
@@ -103,6 +106,10 @@ or ask something. If you are filing in on a bug, please include as much
 information as you can about the issue, and try to recreate the same bug
 in a simple, easily reproducible situation.
 
+### 🏗️ Contributing
+
+Contributions are more than welcome! See [`CONTRIBUTING.md`](https://github.com/althonos/iocursor/blob/master/CONTRIBUTING.md) for more details.
+
 ## ⚖️ License
 
 This library is provided under the [MIT License](https://choosealicense.com/licenses/mit/).

setup.py

@@ -3,6 +3,7 @@
 
 
 import configparser
+import glob
 import os
 import sys
 
@@ -72,17 +73,14 @@ def build_extension(self, ext):
 
 class clean(_clean):
 
-    def run(self):
-
-        source_dir = os.path.join(os.path.dirname(__file__), "pyhmmer")
+    def info(self, message):
+        self.announce(message, level=2)
 
-        patterns = ["*.html"]
+    def run(self):
+        source_dir = os.path.join(os.path.dirname(__file__), "iocursor")
         if self.all:
-            patterns.extend(["*.so", "*.c"])
-
-        for pattern in patterns:
-            for file in glob.glob(os.path.join(source_dir, pattern)):
-                log.info("removing {!r}".format(file))
+            for file in glob.glob(os.path.join(source_dir, "*.so")):
+                self.info("removing {!r}".format(file))
                 os.remove(file)
 
         _clean.run(self)