docs: usage: integration: Add tokei install steps

Fixes: 295

Signed-off-by: John Andersen <[email protected]>

Author: pdxjohnny

docs/api/high_level.rst

@@ -1,6 +1,10 @@
 High Level
 ==========
 
-.. automodule:: dffml.high_level
-   :members:
-   :undoc-members:
+Example usage can be found in the :doc:`/quickstart/model`.
+
+.. autofunction:: dffml.high_level.train
+
+.. autofunction:: dffml.high_level.accuracy
+
+.. autofunction:: dffml.high_level.predict

docs/index.rst

@@ -41,7 +41,6 @@ branch can be found `here <master/index.html>`_.
     :caption: Introduction
 
     about
-    model
     installation
 
 .. toctree::

docs/plugins/dffml_operation.rst

@@ -404,7 +404,26 @@ lines_of_code_by_language
 
 *Core*
 
-No description
+This operation relys on ``tokei``. Here's how to install version 10.1.1,
+check it's releases page to make sure you're installing the latest version.
+
+On Linux
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '22699e16e71f07ff805805d26ee86ecb9b1052d7879350f7eb9ed87beb0e6b84fbb512963d01b75cec8e80532e4ea29a tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
+
+On OSX
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '8c8a1d8d8dd4d8bef93dabf5d2f6e27023777f8553393e269765d7ece85e68837cba4374a2615d83f071dfae22ba40e2 tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
 
 **Stage: processing**
 

docs/usage/dataflows.rst

@@ -189,10 +189,26 @@ We'll be using those operations, so we need to install them
 The ``lines_of_code_to_comments`` operation will give use the ratio of the
 number of lines of comments to the number of lines of code.
 
-.. note::
+You need to install `tokei <https://github.com/XAMPPRocky/tokei>`_ before you
+can use ``lines_of_code_to_comments``.
 
-    You need to install `tokei <https://github.com/XAMPPRocky/tokei>`_ before
-    you can use ``lines_of_code_to_comments``.
+On Linux
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '22699e16e71f07ff805805d26ee86ecb9b1052d7879350f7eb9ed87beb0e6b84fbb512963d01b75cec8e80532e4ea29a tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
+
+On OSX
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '8c8a1d8d8dd4d8bef93dabf5d2f6e27023777f8553393e269765d7ece85e68837cba4374a2615d83f071dfae22ba40e2 tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
 
 The ``lines_of_code_to_comments`` operation needs the output given by
 ``lines_of_code_by_language``, which needs a Git repos source code.

docs/usage/integration.rst

@@ -144,6 +144,27 @@ since that creates more user friendly configs than ``json``.
 
     $ pip install -U dffml-feature-git dffml-config-yaml
 
+The git operations / features rely on ``tokei``. We need to download and install
+it first.
+
+On Linux
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '22699e16e71f07ff805805d26ee86ecb9b1052d7879350f7eb9ed87beb0e6b84fbb512963d01b75cec8e80532e4ea29a tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
+
+On OSX
+
+.. code-block:: console
+
+    $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \
+      | tar -xvz && \
+      echo '8c8a1d8d8dd4d8bef93dabf5d2f6e27023777f8553393e269765d7ece85e68837cba4374a2615d83f071dfae22ba40e2 tokei' | sha384sum -c - && \
+      sudo mv tokei /usr/local/bin/
+
 Operations are just Python functions, or classes. They define a routine which
 will be run concurrently with other operations. Here's an example of the
 ``git_commits`` operation, which will find the number of commits within a date
@@ -153,8 +174,8 @@ range.
 
 .. literalinclude:: /../feature/git/dffml_feature_git/feature/operations.py
     :linenos:
-    :lineno-start: 367
-    :lines: 367-394
+    :lineno-start: 349
+    :lines: 349-368
 
 Since operations are run concurrently with each other, DFFML manages locking of
 input data, such as git repositories. This is done via ``Definitions`` which are

feature/git/dffml_feature_git/feature/operations.py

@@ -289,6 +289,29 @@ async def git_repo_release(
     outputs={"lines_by_language": lines_by_language_count},
 )
 async def lines_of_code_by_language(repo: Dict[str, str]):
+    """
+    This operation relys on ``tokei``. Here's how to install version 10.1.1,
+    check it's releases page to make sure you're installing the latest version.
+
+    On Linux
+
+    .. code-block:: console
+
+        $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \\
+          | tar -xvz && \\
+          echo '22699e16e71f07ff805805d26ee86ecb9b1052d7879350f7eb9ed87beb0e6b84fbb512963d01b75cec8e80532e4ea29a tokei' | sha384sum -c - && \\
+          sudo mv tokei /usr/local/bin/
+
+    On OSX
+
+    .. code-block:: console
+
+        $ curl -sSL 'https://github.com/XAMPPRocky/tokei/releases/download/v10.1.1/tokei-v10.1.1-x86_64-apple-darwin.tar.gz' \\
+          | tar -xvz && \\
+          echo '8c8a1d8d8dd4d8bef93dabf5d2f6e27023777f8553393e269765d7ece85e68837cba4374a2615d83f071dfae22ba40e2 tokei' | sha384sum -c - && \\
+          sudo mv tokei /usr/local/bin/
+
+    """
     # cloc creates temporary files >:(
     proc = await create("tokei", repo.directory, cwd=repo.directory)
     cols = []