Add changelog and bump version in preparation for release.

davidblewett · davidblewett · commit 41cab0efcafb · 2017-10-09T12:24:40.000-04:00
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -0,0 +1,13 @@
+=======
+History
+=======
+
+0.1.2 (2017-10-09)
+------------------
+
+* First release on PyPI
+* Binary wheels compiled against:
+
+    * Rust: 1.20.0
+    * regex: 0.2.2
+    * rure (regex-capi): 0.2.0
diff --git a/README.rst b/README.rst
@@ -76,10 +76,19 @@ implemented yet.
 
 Install
 -------
-Binary wheels are provided for Linux. Installing from a source tarball requires
-manually building the Rust `rure` crate and pointing at the built directory:
+Binary wheels are provided for Linux and MacOS. The specific versions of the Rust
+compiler, `rure` and `regex` crates will be available in the changelog.
+
+Installing from a source tarball requires manually building the Rust `rure` crate and
+pointing at the built directory. If you are wanting to take advantage of a modern CPU,
+it's likely that you'll want to build the `regex` crate with SSE3 and SIMD. To do so,
+you will need to update the `regex/regex-capi/Cargo.toml` to include the `simd-accel`
+feature: `regex = { version = "0.2.2", path = "..", features=["simd-accel"] }`.
 
 * git clone https://github.com/rust-lang-nursery/regex
-* cargo build --release --manifest-path /path/to/regex/regex-capi/Cargo.toml
-* RURE_DIR=/path/to/regex/regex-capi python setup.py bdist_wheel
-* pip install rure --no-index -f ./dist
+* `cargo build --release --manifest-path /path/to/regex/regex-capi/Cargo.toml`
+
+    * To build with SSE3: `RUSTFLAGS="-C target-feature=+ssse3" cargo build --release --features simd-accel`
+
+* `RURE_DIR=/path/to/regex/regex-capi python setup.py bdist_wheel`
+* `pip install rure --no-index -f ./dist`
diff --git a/setup.py b/setup.py
@@ -10,18 +10,21 @@
 cur_dir = os.path.dirname(os.path.abspath(__file__))
 with open(os.path.join(cur_dir, 'README.rst')) as buf:
     README = buf.read()
+with open(os.path.join(cur_dir, 'HISTORY.rst')) as buf:
+    HISTORY = buf.read()
+
 rure_dir = os.getenv('RURE_DIR', cur_dir)
 print('rure_dir:', rure_dir)
 
 setup(
     name='rure',
-    version='0.1.1',
+    version='0.1.2',
     author='David Blewett',
     author_email='david@dawninglight.net',
     description=('Python bindings for the Rust `regex` create. '
                  'This implementation uses finite automata and guarantees '
                  'linear time matching on all inputs.'),
-    long_description=README,
+    long_description=README + '\n\n' + HISTORY,
     license='MIT',
     keywords=['regex', 'rust', 'dfa', 'automata', 'data_structures'],
     url='https://github.com/davidblewett/rure-python',
