Merge pull request #73 from isabelizimm/precommit

bulk precommit

Author: isabelizimm

.github/ISSUE_TEMPLATE/release-checklist.md

@@ -10,7 +10,7 @@ assignees: ''
 Prepare for release:
 
 - [ ] `pre-commit run`
-- [ ] `pytest vetiver/tests/` 
+- [ ] `pytest vetiver/tests/`
 - [ ] bump release number
 
 Submit to PyPI:

.pre-commit-config.yaml

@@ -1,11 +1,20 @@
+
+
+exclude: "(.*\\.csv)|(^pins/tests/_snapshots)"
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.4.0
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 21.12b0
+      - id: flake8
+        # line too long and line before binary operator (black is ok with these)
+        types:
+          - python
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: ["--unsafe"]
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
     hooks:
-    -   id: black
+      - id: black

README.md

@@ -35,7 +35,7 @@ python -m pip install git+https://github.com/rstudio/vetiver-python
 
 ## Example
 
-A `VetiverModel()` object collects the information needed to store, version, and deploy a trained model. 
+A `VetiverModel()` object collects the information needed to store, version, and deploy a trained model.
 
 ```python
 from vetiver import mock, VetiverModel

docs/figures/logo.svg

@@ -8,7 +8,7 @@ from vetiver.handlers.base import VetiverHandler
 class SampleCustomHandler(VetiverHandler):
     def __init__(model, ptype_data):
         super().__init__(model, ptype_data)
-    
+
     def handler_predict(self, input_data, check_ptype):
         """
         handler_predict defines how to make predictions from your model
@@ -17,9 +17,9 @@ class SampleCustomHandler(VetiverHandler):
 ```
 
 ## New model type
-If your model type is not supported by vetiver, you should create and then register the handler using [single dispatch](https://docs.python.org/3/library/functools.html#functools.singledispatch). Once the new type is registered, you are able to use `VetiverModel()` as normal. Here is a template for such a function: 
+If your model type is not supported by vetiver, you should create and then register the handler using [single dispatch](https://docs.python.org/3/library/functools.html#functools.singledispatch). Once the new type is registered, you are able to use `VetiverModel()` as normal. Here is a template for such a function:
 
-```python    
+```python
 from vetiver.handlers._interface import create_handler
 
 @create_handler.register
@@ -34,8 +34,8 @@ If your model is a common type, please consider [submitting a pull request](http
 ## Different model implementation
 If your model's prediction function is different than vetiver's, you should create a custom handler with a `handler_predict` method to make predictions. Then, initialize your handler with your model, and pass the object into `VetiverModel`.
 
-```python    
+```python
 new_model = SampleCustomHandler(your_model, your_ptype_data)
 
 VetiverModel(new_model, "your_model")
-```
+```

docs/source/advancedusage/custom_handler.md

@@ -1,20 +1,9 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
 from vetiver import __version__
 
+sys.path.insert(0, os.path.abspath("."))
+
 
 # -- Project information -----------------------------------------------------
 
@@ -38,7 +27,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.githubpages",
     "sphinx.ext.autodoc",
-    "myst_parser"
+    "myst_parser",
 ]
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -61,14 +50,13 @@
     "use_repository_button": True,
     "use_issues_button": True,
     "use_edit_page_button": True,
-    "home_page_in_toc": True
-
+    "home_page_in_toc": True,
 }
 
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.txt': 'markdown',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
 }
 myst_heading_anchors = 2
 

docs/source/conf.py

@@ -36,7 +36,6 @@ Version
    :caption: Version
 
    ~VetiverModel
-   ~pin_read_write.vetiver_pin_read
    ~pin_read_write.vetiver_pin_write
 
 Deploy
@@ -51,13 +50,11 @@ Deploy
    ~VetiverAPI.vetiver_post
    ~vetiver_endpoint
    ~predict
-   ~load_pkgs
-   ~vetiver_write_app
-   ~vetiver_write_docker
+   ~write_app
+   ~write_docker
 
 Advanced Usage
 ==================
 .. toctree::
    advancedusage/custom_handler.md
    :caption: Advanced Usage
-   

docs/source/index.rst

@@ -5,26 +5,24 @@
 
 .. autoclass:: VetiverAPI
 
-   
+
    .. automethod:: __init__
 
-   
+
    .. rubric:: Methods
 
    .. autosummary::
-   
+
       ~VetiverAPI.__init__
       ~VetiverAPI.run
       ~VetiverAPI.vetiver_post
-   
-   
 
-   
-   
+
+
+
+
    .. rubric:: Attributes
 
    .. autosummary::
-   
+
       ~VetiverAPI.app
-   
-   

docs/source/reference/vetiver.VetiverAPI.rst

@@ -3,4 +3,4 @@
 
 .. currentmodule:: vetiver
 
-.. automethod:: VetiverAPI.run
+.. automethod:: VetiverAPI.run

docs/source/reference/vetiver.VetiverAPI.run.rst

@@ -3,4 +3,4 @@
 
 .. currentmodule:: vetiver
 
-.. automethod:: VetiverAPI.vetiver_post
+.. automethod:: VetiverAPI.vetiver_post