Merge branch 'main' into server-refactor

Author: isabelizimm

.github/workflows/docs.yml

@@ -20,29 +20,31 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -e .[dev]
+          python -m pip install -e .[docs]
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
       - name: build docs
         run: |
           make docs
       - name: save docs
         uses: actions/upload-artifact@v3
         with:
           name: docs-html
-          path: docs/_build/html/
+          path: docs/_site
       - name: publish dev docs
         if: github.ref_name == 'main' && github.ref_type == 'branch'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_build/*
+          publish_dir: docs/_site
           publish_branch: gh-pages
           destination_dir: main
       - name: publish stable docs
         if: github.ref_type == 'tag' && startswith(github.ref, 'refs/tags/v')
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/_build/*
+          publish_dir: docs/_site
           publish_branch: gh-pages
           destination_dir: ${{ github.ref_name }}
       - name: create symlink stable to new version

.github/workflows/tests.yml

@@ -54,7 +54,7 @@ jobs:
           python -m pip install ".[dev]"
           python -m pip install --upgrade git+https://github.com/rstudio/vetiver-python@${{ github.sha }}
           echo {{ github.sha }}
-      - name: run RStudio Connect
+      - name: run Connect
         run: |
           docker-compose up --build -d
           pip freeze > requirements.txt

.github/workflows/weekly.yml

@@ -9,6 +9,8 @@ name: Weekly Tests
 on:
   schedule:
     - cron: "03 14 * * MON"
+  push:
+    branches: ['update-weekly']
 
 jobs:
   vetiver_main_pins_main:
@@ -35,7 +37,7 @@ jobs:
           python -m pip install '.[all]'
           python -m pip install --upgrade git+https://github.com/rstudio/pins-python
 
-      - name: run RStudio Connect
+      - name: run Connect
         run: |
           docker-compose up --build -d
           make dev
@@ -82,7 +84,7 @@ jobs:
           python -m pip install .[dev]
           python -m pip install --upgrade git+https://github.com/rstudio/pins-python
 
-      - name: run RStudio Connect
+      - name: run Connect
         run: |
           docker-compose up --build -d
           make dev
@@ -101,7 +103,7 @@ jobs:
     strategy:
       matrix:
         # Minimum and Maximum supported versions
-        python-version: ['3.10']
+        python-version: ['3.9']
 
     steps:
       - name: Get latest release with tag from GitHub API
@@ -129,7 +131,7 @@ jobs:
           python -m pip install --upgrade git+https://github.com/rstudio/rsconnect-python
           pip freeze > requirements.txt
 
-      - name: run RStudio Connect
+      - name: run Connect
         run: |
           docker-compose up --build -d
           make dev
@@ -148,7 +150,7 @@ jobs:
     strategy:
       matrix:
         # Minimum and Maximum supported versions
-        python-version: ['3.10']
+        python-version: ['3.9']
 
     steps:
       - uses: actions/checkout@v2
@@ -164,7 +166,7 @@ jobs:
           python -m pip install --upgrade git+https://github.com/rstudio/rsconnect-python
           pip freeze > requirements.txt
 
-      - name: run RStudio Connect
+      - name: run Connect
         run: |
           docker-compose up --build -d
           make dev

.gitignore

@@ -142,3 +142,5 @@ NOTES.md
 ## RStudio
 *.Rproj
 .Rproj.user
+
+/.quarto/

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 
 
-exclude: "(.*\\.csv)|(^examples/)|(^vetiver/tests/snapshots/)"
+exclude: "(.*\\.csv)|(^examples/)|(^vetiver/tests/snapshots/)|(^docs/_extensions/)"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.4.0

CODE_OF_CONDUCT.md

@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -21,25 +21,25 @@ community include:
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes,
-and learning from the experience
+  and learning from the experience
 * Focusing on what is best not just for us as individuals, but for the overall
-community
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-advances of any kind
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-address, without their explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
-professional setting
+  professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards
-of acceptable behavior and will take appropriate and fair corrective action in
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
 response to any behavior that they deem inappropriate, threatening, offensive,
 or harmful.
 
@@ -50,17 +50,17 @@ decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies
-when an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail
-address, posting via an official social media account, or acting as an appointed
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at [INSERT CONTACT
-METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+reported to the community leaders responsible for enforcement at codeofconduct@posit.co.
+All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
@@ -114,15 +114,13 @@ community.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/
-code_of_conduct.html.
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://
-www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Isabel Zimmerman
+Copyright (c) 2021 vetiver authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MAINTAINERS.md

@@ -0,0 +1,5 @@
+# Who maintains Vetiver
+
+Vetiver was created by and is currently maintained by Isabel Zimmerman <isabel.zimmerman@posit.co>.
+
+Several individuals in the community have taken an active role in helping to maintain vetiver and submit fixes. Those individuals are shown in the git changelog.

Makefile

@@ -1,10 +1,6 @@
 .PHONY: clean-pyc clean-build clean docs
 UNAME := $(shell uname)
 
-SPHINX_BUILDARGS=
-# Note that these are keys generated by the docker rsconnect service, so are
-# not really secrets. They are saved to json to make it easy to use rsconnect
-# as multiple users from the tests
 RSC_API_KEYS=vetiver/tests/rsconnect_api_keys.json
 
 ifeq ($(UNAME), Darwin)
@@ -22,16 +18,15 @@ help:
 	@echo "test - run tests quickly with the default Python"
 	@echo "test-rsc - run tests for rsconnect"
 	@echo "coverage - check code coverage quickly with the default Python"
-	@echo "docs - generate Sphinx HTML documentation, including API docs"
-	@echo "cdocs - cleanout previous build & generate Sphinx HTML documentation, including API docs"
+	@echo "docs - generate HTML documentation, including API docs"
 	@echo "release - package and upload a release"
 	@echo "dist - package"
 	@echo "install - install the package to the active Python's site-packages"
-	@echo "dev - generate RStudio Connect API keys"
-	@echo "dev-start - start up development RStudio Connect in Docker"
-	@echo "dev-stop - stop RStudio Connect dev container"
+	@echo "dev - generate Connect API keys"
+	@echo "dev-start - start up development Connect in Docker"
+	@echo "dev-stop - stop Connect dev container"
 
-clean: clean-build clean-pyc clean-test docs-clean
+clean: clean-build clean-pyc clean-test
 
 clean-build:
 	rm -fr build/
@@ -68,14 +63,8 @@ coverage:
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
-cdocs cdoc cdocumentation: docs-clean docs
-
-docs-clean:
-	$(MAKE) -C docs clean
-
 docs doc documentation:
-	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
+	$(MAKE) -C docs docs
 
 release: dist
 	twine upload dist/*

README.md

@@ -1,4 +1,4 @@
-# vetiver <a href='https://rstudio.github.io/vetiver-python/'><img src='docs/figures/logo.png' align="right" height="139" /></a>
+# vetiver <a href='https://rstudio.github.io/vetiver-python/'><img src='docs/figures/logo.png' align="right" height="138" /></a>
 
 <!-- badges: start -->
 
@@ -49,7 +49,7 @@ model = mock.get_mock_model().fit(X, y)
 v = VetiverModel(model, model_name='mock_model', prototype_data=X)
 ```
 
-You can **version** and **share** your `VetiverModel()` by choosing a [pins](https://rstudio.github.io/pins-python/) "board" for it, including a local folder, RStudio Connect, Amazon S3, and more.
+You can **version** and **share** your `VetiverModel()` by choosing a [pins](https://rstudio.github.io/pins-python/) "board" for it, including a local folder, [Connect](https://posit.co/products/enterprise/connect/), Amazon S3, and more.
 
 ```python
 from pins import board_temp
@@ -72,6 +72,6 @@ To start a server using this object, use `app.run(port = 8080)` or your port of
 
 This project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
 
-- For questions and discussions about deploying models, statistical modeling, and machine learning, please [post on RStudio Community](https://community.rstudio.com/new-topic?category_id=15&tags=vetiver,question).
+- For questions and discussions about deploying models, statistical modeling, and machine learning, please [post on Posit Community](https://community.rstudio.com/new-topic?category_id=15&tags=vetiver,question).
 
 - If you think you have encountered a bug, please [submit an issue](https://github.com/rstudio/vetiver-python/issues).