MAINT set version number to 3.1.0.dev2 for a pre-release

jacksonllee · Nov 9, 2020 · 7ae0464 · 7ae0464
2 parents 00508ef + 2944cf2
commit 7ae0464
Show file tree

Hide file tree

Showing 47 changed files with 133 additions and 114 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -40,6 +40,24 @@ jobs:
         #  password: $DOCKERHUB_PASSWORD
     steps:
       - checkout
+      - run:
+          name: Install Git LFS
+          command: |
+            curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
+            sudo apt-get -y install git-lfs
+            git lfs install
+      - run:
+          name: Create an asset id file of Git LFS files
+          command: git lfs ls-files -l | cut -d' ' -f1 | sort > .assets-id
+      - restore_cache:
+          key: v1-my-cache-key-{{ checksum ".assets-id" }}
+      - run:
+          name: Fetch the files under Git LFS
+          command: git lfs pull
+      - save_cache:
+          key: v1-my-cache-key-{{ checksum ".assets-id" }}
+          paths:
+            - .git/lfs
       - python/install-packages:
           pkg-manager: pip
           pre-install-steps:
@@ -52,8 +70,7 @@ jobs:
       - run:
           name: Check for PyPI compliance via twine
           working_directory: ~/project/
-          command: |
-            twine check dist/`ls dist/ | grep .tar.gz`
+          command: twine check dist/`ls dist/ | grep .tar.gz`
       - run:
           name: Show installed Python packages
           command: pip list -v
@@ -62,8 +79,7 @@ jobs:
           working_directory: ~/
           # Avoid being able to import pycantonese by relative import.
           # Test code by importing the *installed* pycantonese in site-packages.
-          command: |
-              pytest -vv project/pycantonese --junitxml /tmp/testxml/report.xml
+          command: pytest -vv project/pycantonese --junitxml /tmp/testxml/report.xml
       - store_test_results:
           path: /tmp/testxml/
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 83fadb6c7bf054ce9ed4f220ae7402b5
+config: c2ebe658e7604b3d94aad9e23ef24f82
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>Overview: module code &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/corpus.html b/docs/_modules/pycantonese/corpus.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.corpus &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.corpus &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/jyutping/characters.html b/docs/_modules/pycantonese/jyutping/characters.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.characters &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.jyutping.characters &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/jyutping/parse_jyutping.html b/docs/_modules/pycantonese/jyutping/parse_jyutping.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.parse_jyutping &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.jyutping.parse_jyutping &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/jyutping/tipa.html b/docs/_modules/pycantonese/jyutping/tipa.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.tipa &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.jyutping.tipa &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/jyutping/yale.html b/docs/_modules/pycantonese/jyutping/yale.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.jyutping.yale &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.jyutping.yale &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/pos_tagging/hkcancor_to_ud.html b/docs/_modules/pycantonese/pos_tagging/hkcancor_to_ud.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.pos_tagging.hkcancor_to_ud &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.pos_tagging.hkcancor_to_ud &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/pos_tagging/tagger.html b/docs/_modules/pycantonese/pos_tagging/tagger.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.pos_tagging.tagger &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.pos_tagging.tagger &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 
@@ -280,6 +280,13 @@ <h1>Source code for pycantonese.pos_tagging.tagger</h1><div class="highlight"><p
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
 
 
+<span class="c1"># Use the highest pickle protocol version that&#39;s compatible for all supported</span>
+<span class="c1"># Python versions.</span>
+<span class="c1"># Protocol version 4 was added in Python 3.4.</span>
+<span class="c1"># Protocol version 5 was added in Python 3.8.</span>
+<span class="c1"># Reference: https://docs.python.org/3/library/pickle.html#data-stream-format</span>
+<span class="n">_PICKLE_PROTOCOL</span> <span class="o">=</span> <span class="mi">4</span>
+
 <span class="n">_THIS_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
 <span class="n">_PICKLE_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_THIS_DIR</span><span class="p">,</span> <span class="s2">&quot;tagger.pickle&quot;</span><span class="p">)</span>
 
@@ -493,7 +500,7 @@ <h1>Source code for pycantonese.pos_tagging.tagger</h1><div class="highlight"><p
             <span class="n">pickle</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span>
                 <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">weights</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tagdict</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">),</span>
                 <span class="nb">open</span><span class="p">(</span><span class="n">save</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">),</span>
-                <span class="n">protocol</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span>
+                <span class="n">protocol</span><span class="o">=</span><span class="n">_PICKLE_PROTOCOL</span><span class="p">,</span>
             <span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>

diff --git a/docs/_modules/pycantonese/stop_words.html b/docs/_modules/pycantonese/stop_words.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.stop_words &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.stop_words &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pycantonese/word_segmentation.html b/docs/_modules/pycantonese/word_segmentation.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.word_segmentation &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.word_segmentation &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_modules/pylangacq/chat.html b/docs/_modules/pylangacq/chat.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pylangacq.chat &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pylangacq.chat &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/_sources/pos_tagging.rst.txt b/docs/_sources/pos_tagging.rst.txt
@@ -11,18 +11,15 @@ Part-of-Speech Tagging
     is available only through the GitHub repository for early testers.
     Everything (what functions are provided, how they behave) is subject to
     change while it is still under active development.
-    To download and install this (unstable) version of PyCantonese::
+    To download and install this (unstable) version of PyCantonese
+    (the ``--pre`` flag means a pre-release version):
 
-    1. If you haven't done so already, install `Git LFS <https://git-lfs.github.com/>`_ on your system.
-       You only have to do this step once per system. Git LFS is to enable
-       the proper fetching of model files (such as the POS tagger) stored
-       differently due to its file size and/or binary nature.
+    .. code-block:: bash
 
-    2. Download and install PyCantonese from the GitHub source:
+        $ pip install --pre --upgrade pycantonese
 
-       .. code-block:: bash
-
-           $ pip install git+https://github.com/jacksonllee/pycantonese.git@master#egg=pycantonese
+    Running ``import pycantonese as pc; print(pc.__version__)`` will show a
+    version number similar to ``3.1.0.dev2``.
 
     If you notice any issues, please don't hesitate to
     `report them <https://pycantonese.org/#links>`_.

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.0.0',
+    VERSION: '3.1.0.dev2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api.html b/docs/api.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>API Reference &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>API Reference &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Changelog &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>Changelog &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/data.html b/docs/data.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Corpus Data &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>Corpus Data &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/generated/pycantonese.characters_to_jyutping.html b/docs/generated/pycantonese.characters_to_jyutping.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.characters_to_jyutping &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.characters_to_jyutping &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>
 
 

diff --git a/docs/generated/pycantonese.corpus.CantoneseCHATReader.html b/docs/generated/pycantonese.corpus.CantoneseCHATReader.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>pycantonese.corpus.CantoneseCHATReader &mdash; PyCantonese 3.0.0 documentation</title>
+  <title>pycantonese.corpus.CantoneseCHATReader &mdash; PyCantonese 3.1.0.dev2 documentation</title>
 
 
 
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                3.0.0
+                3.1.0.dev2
               </div>