Merge pull request #4 from gandersen101/develop

Read the docs

.github/release-drafter.yml

@@ -0,0 +1,27 @@
+categories:
+  - title: ':boom: Breaking Changes'
+    label: 'breaking'
+  - title: ':package: Build System'
+    label: 'build'
+  - title: ':construction_worker: Continuous Integration'
+    label: 'ci'
+  - title: ':books: Documentation'
+    label: 'documentation'
+  - title: ':rocket: Features'
+    label: 'enhancement'
+  - title: ':beetle: Fixes'
+    label: 'bug'
+  - title: ':racehorse: Performance'
+    label: 'performance'
+  - title: ':hammer: Refactoring'
+    label: 'refactoring'
+  - title: ':fire: Removals and Deprecations'
+    label: 'removal'
+  - title: ':lipstick: Style'
+    label: 'style'
+  - title: ':rotating_light: Testing'
+    label: 'testing'
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/release-drafter.yml

@@ -0,0 +1,12 @@
+name: Release Drafter
+on:
+  push:
+    branches:
+      - master
+jobs:
+  draft_release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -1,5 +1,5 @@
 name: Tests
-on: [push, pull_request]
+on: push
 jobs:
   tests:
     runs-on: ${{matrix.os}}

.readthedocs.yml

@@ -0,0 +1,9 @@
+version: 2
+sphinx:
+  configuration: docs/conf.py
+formats: all
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt
+    - path: .

README.md

@@ -1,6 +1,7 @@
 [![Tests](https://github.com/gandersen101/spaczz/workflows/Tests/badge.svg)](https://github.com/gandersen101/spaczz/actions?workflow=Tests)
 [![Codecov](https://codecov.io/gh/gandersen101/spaczz/branch/master/graph/badge.svg)](https://codecov.io/gh/gandersen101/spaczz)
 [![PyPI](https://img.shields.io/pypi/v/spaczz.svg)](https://pypi.org/project/spaczz/)
+[![Read the Docs](https://readthedocs.org/projects/spaczz/badge/)](https://spaczz.readthedocs.io/)
 
 # spaczz: Fuzzy matching and more for spaCy
 

docs/index.rst

@@ -24,7 +24,7 @@ Spaczz can be installed using pip. It is strongly recommended that the
 “fast” extra is installed. This installs the optional python-Levenshtein
 package which speeds up fuzzywuzzy’s fuzzy matching by 4-10x.
 
-.. code:: ipython3
+.. code:: Python
 
     # Basic Install
     pip install spaczz
@@ -35,6 +35,6 @@ package which speeds up fuzzywuzzy’s fuzzy matching by 4-10x.
 If you decide to install the optional python-Levenshtein package later
 simply pip install it when desired.
 
-.. code:: ipython3
+.. code:: Python
 
     pip install python-Levenshtein

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx==3.1.1
+sphinx-autodoc-typehints==1.11.0

pyproject.toml

@@ -1,20 +1,22 @@
 [tool.poetry]
 name = "spaczz"
-version = "0.1.0"
+version = "0.1.1"
 description = "Adds fuzzy matching and additional regex matching support to spaCy."
 license = "MIT"
 readme = "README.md"
-homepage = "https://github.com/<gandersen101/spaczz"
+homepage = "https://github.com/gandersen101/spaczz"
 repository = "https://github.com/gandersen101/spaczz"
 keywords = ["fuzzy matching", "spacy", "fuzzywuzzy"]
 authors = ["Grant Andersen <gandersen.codes@gmail.com>"]
+documentation = "https://spaczz.readthedocs.io"
 
 [tool.poetry.dependencies]
 python = "^3.7"
 spacy = "^2.2.0"
 fuzzywuzzy = "^0.18.0"
 python-Levenshtein = {version = "^0.12.0", optional = true}
 regex = "^2020.6.8"
+importlib_metadata = {version = "^1.7.0", python = "<3.8"}
 
 [tool.poetry.dev-dependencies]
 flake8 = "^3.8.3"

src/spaczz/__init__.py

@@ -1,2 +1,11 @@
 """spaczz library for fuzzy matching and extended regex functionality with spaCy."""
-__version__ = "0.1.0"
+try:
+    from importlib.metadata import version, PackageNotFoundError  # type: ignore
+except ImportError:  # pragma: no cover
+    from importlib_metadata import version, PackageNotFoundError  # type: ignore
+
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"