Merge branch 'master' into sagerb-handle-pip-notices

Author: sagerb

.flake8

@@ -26,16 +26,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     name: test (py${{ matrix.python-version }} ${{ matrix.os }})
     steps:
-    - uses: actions/checkout@v2
-    - run: git fetch --prune --unshallow
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - run: pip install -r requirements.txt
+    - run: pip install '.[test]'
     - run: pip freeze
     - run: make fmt
     - run: make lint
-    - run: python setup.py --version
+    - run: rsconnect version
     - run: make test-${{ matrix.python-version }}
     - if: github.event_name == 'pull_request' && matrix.python-version == '3.8'
       uses: orgoro/coverage@v3
@@ -47,28 +50,34 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: true
     steps:
-    - uses: actions/checkout@v2
-    - run: git fetch --prune --unshallow
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - uses: actions/setup-python@v2
       with:
         python-version: 3.8.x
-    - run: pip install --pre -r requirements.txt
+    - run: pip install --pre '.[test]'
     - run: pip freeze
     - run: make fmt
     - run: make lint
-    - run: python setup.py --version
+    - run: rsconnect version
     - run: make mock-test-3.8
 
   distributions:
     needs: test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - run: git fetch --prune --unshallow
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - uses: actions/setup-python@v2
       with:
         python-version: 3.8.x
-    - run: pip install -r requirements.txt
+    - run: pip install -e '.[test]'
     - run: pip freeze
     - run: make dist
       id: create_dist
@@ -117,12 +126,14 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - run: git fetch --prune --unshallow
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - uses: actions/setup-python@v2
       with:
         python-version: 3.8.x
-    - run: pip install -r requirements.txt
     - run: pip freeze
     - run: make docs
     - uses: actions/upload-artifact@v2
@@ -163,15 +174,15 @@ jobs:
     name: "Integration tests against latest Connect"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: actions/setup-python@v2
         with:
           python-version: 3.8
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirements.txt
           python -m pip install -r vetiver-testing/vetiver-requirements.txt
+          python -m pip install '.[test]'
       - name: Run RStudio Connect
         run: |
           docker-compose up --build -d
@@ -197,7 +208,9 @@ jobs:
       CONNECT_LICENSE: ${{ secrets.RSC_LICENSE }}
       ADMIN_API_KEY: ${{ secrets.ADMIN_API_KEY }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - uses: extractions/setup-just@v1

.github/workflows/main.yml

@@ -42,8 +42,5 @@ jobs:
 
       - uses: snyk/actions/setup@master
 
-      - name: Run Snyk (setup.py)
-        run: snyk monitor --file="setup.py" --package-manager=pip --project-name="setup.py" --org=${{ env.SNYK_ORG }}
-
       - name: Run Snyk (requirements.txt)
         run: snyk monitor --file="requirements.txt" --package-manager=pip --project-name="requirements.txt" --org=${{ env.SNYK_ORG }}

.github/workflows/snyk.yml

@@ -22,6 +22,7 @@
 /rsconnect-build-test
 /rsconnect/version.py
 /tests/testdata/**/rsconnect-python/
+env
 htmlcov
 test-home/
 venv

.gitignore

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## Unreleased
 
 ### Fixed
@@ -27,10 +28,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   recognized filename patterns, the file patterns `app-*.py`, `app_*.py`, `*-app.py`,
   and `*_app.py` are now considered. However, if the directory contains more than
   one file matching these new patterns, you must provide rsconnect-python with an
-  explicit `--entrypoint` argument.
+  explicit `--entrypoint` argument.\
 - Added a new verbose logging level. Specifying `-v` on the command line uses this
   new level. Currently this will cause filenames to be logged as they are added to
   a bundle. To enable maximum verbosity (debug level), use `-vv`.
+- Added the `deploy flask` command.
+- Added the `write-manifest flask` command.
 
 ### Changed
 - Removing experimental support for Conda. Connect does not support restoring Conda environments.

CHANGELOG.md

@@ -22,11 +22,10 @@ cd rsconnect-python
 python3 -m venv .venv
 # Activate the virtual environment
 source .venv/bin/activate
-# install our requirements into the virtual environment
-pip install -r requirements.txt
-# install rsconnect-python with a symbolic link to the locations repository, 
-# meaning any changes to code in there will automatically be reflected
-pip install -e ./
+# Install rsconnect-python with a symbolic link to the locations repository,
+# meaning any changes to code in there will automatically be reflected.
+# Also install dev/test dependencies.
+pip install -e '.[test]'
 ```
 
 ## Workflow
@@ -46,8 +45,8 @@ make test
 make all-tests
 ```
 
-As another example, the [`test` job in the default GitHub Actions workflow](.github/workflows/main.yml) 
-uses some of these targets during the CI for building and testing. 
+As another example, the [`test` job in the default GitHub Actions workflow](.github/workflows/main.yml)
+uses some of these targets during the CI for building and testing.
 
 ## Proposing Change
 
@@ -82,7 +81,7 @@ a release will be created and published to the repository
 
 rsconnect-python exists on conda-forge as its own [feedstock](https://github.com/conda-forge/rsconnect-python-feedstock)
 
-Updating the package requires a fork of the repository and a [push request](https://github.com/conda-forge/rsconnect-python-feedstock#updating-rsconnect-python-feedstock). 
+Updating the package requires a fork of the repository and a [push request](https://github.com/conda-forge/rsconnect-python-feedstock#updating-rsconnect-python-feedstock).
 
 - For new version/release, update the [meta.yaml](https://github.com/conda-forge/rsconnect-python-feedstock/blob/master/recipe/meta.yaml) file with the new version number, source url, and corresponding checksum.
 

CONTRIBUTING.md

@@ -3,5 +3,4 @@ FROM ${BASE_IMAGE}
 
 WORKDIR /rsconnect
 COPY scripts/build-image build-image
-COPY requirements.txt requirements.txt
 RUN bash build-image && rm -vf build-image

Dockerfile

@@ -1,4 +1,4 @@
-VERSION := $(shell python setup.py --version)
+VERSION := $(shell python -m setuptools_scm)
 HOSTNAME := $(shell hostname)
 S3_PREFIX := s3://rstudio-connect-downloads/connect/rsconnect-python
 
@@ -67,13 +67,6 @@ fmt-%:
 	@echo ERROR: This python version cannot run the fmting tools
 	@exit 1
 
-.PHONY: deps-prerelease
-deps-prerelease:
-	pip install --pre -r requirements.txt
-
-deps-%:
-	$(RUNNER) 'pip install --pre -r requirements.txt'
-
 lint-%:
 	$(RUNNER) 'black --check --diff rsconnect/'
 	$(RUNNER) 'flake8 rsconnect/'
@@ -112,10 +105,6 @@ test: test-3.8
 lint: RUNNER = bash -c
 lint: lint-3.8
 
-.PHONY: deps
-deps: RUNNER = bash -c
-deps: deps-3.8
-
 .PHONY: fmt
 fmt: RUNNER = bash -c
 fmt: fmt-3.8
@@ -133,12 +122,16 @@ version:
 # exported as a point of reference instead.
 .PHONY: dist
 dist:
-	python setup.py bdist_wheel
+	pip wheel --no-deps -w dist .
 	twine check $(BDIST_WHEEL)
 	rm -vf dist/*.egg
 	@echo "::set-output name=whl::$(BDIST_WHEEL)"
 	@echo "::set-output name=whl_basename::$(notdir $(BDIST_WHEEL))"
 
+.PHONY: dist-install
+dist-install: dist
+	pip install $(BDIST_WHEEL)
+
 .PHONY: sync-to-s3
 sync-to-s3:
 	aws s3 cp --acl bucket-owner-full-control \

Makefile

@@ -42,7 +42,7 @@ You may also build and install a wheel directly from a repository clone:
 git clone https://github.com/rstudio/rsconnect-python.git
 cd rsconnect-python
 pip install pipenv
-make deps dist
+make dist
 pip install ./dist/rsconnect_python-*.whl
 ```
 
@@ -117,7 +117,7 @@ you will need to include the `--cacert` option that points to your certificate
 authority (CA) trusted certificates file. Both of these options can be saved along
 with the URL and API Key for a server.
 
-> **Note** 
+> **Note**
 > When certificate information is saved for the server, the specified file
 > is read and its _contents_ are saved under the server's nickname. If the CA file's
 > contents are ever changed, you will need to add the server information again.
@@ -135,7 +135,7 @@ rsconnect add \
     --name myserver
 ```
 
-> **Note** 
+> **Note**
 > The `rsconnect` CLI will verify that the serve URL and API key
 > are valid. If either is found not to be, no information will be saved.
 
@@ -270,8 +270,9 @@ rsconnect write-manifest notebook my-notebook.ipynb
 You can deploy a variety of APIs and applications using sub-commands of the
 `rsconnect deploy` command.
 
-* `api`: WSGI-compliant APIs such as Flask and packages based on Flask
-* `fastapi`: ASGI-compliant APIs (FastAPI, Quart, Sanic, and Falcon)
+* `api`: WSGI-compliant APIs (e.g., `bottle`, `falcon`, `flask`, `flask-restx`, `flasgger`, `pycnic`).
+* `flask`: Flask APIs (_Note: `flask` is an alias of `api`._).
+* `fastapi`: ASGI-compliant APIs (e.g, `fastapi`, `quart`, `sanic`, `starlette`)
 * `dash`: Python Dash apps
 * `streamlit`: Streamlit apps
 * `bokeh`: Bokeh server apps
@@ -430,7 +431,7 @@ filename referenced in the manifest.
 
 ### Environment variables
 You can set environment variables during deployment. Their names and values will be
-passed to Posit Connect during deployment so you can use them in your code. Note that 
+passed to Posit Connect during deployment so you can use them in your code. Note that
 if you are using `rsconnect` to deploy to shinyapps.io, environment variable management
 is not supported on that platform.
 
@@ -985,9 +986,9 @@ xargs printf -- '-g %s\n' < guids.txt | xargs rsconnect content build add
 ```
 ## Programmatic Provisioning
 
-Posit Connect supports the programmatic bootstrapping of an administrator API key 
+Posit Connect supports the programmatic bootstrapping of an administrator API key
 for scripted provisioning tasks. This process is supported by the `rsconnect bootstrap` command,
-which uses a JSON Web Token to request an initial API key from a fresh Connect instance. 
+which uses a JSON Web Token to request an initial API key from a fresh Connect instance.
 
 > **Warning**
 > This feature **requires Python version 3.6 or higher**.
@@ -998,7 +999,7 @@ rsconnect bootstrap \
     --jwt-keypath /path/to/secret.key
 ```
 
-A full description on how to use `rsconnect bootstrap` in a provisioning workflow is provided in the Connect administrator guide's 
+A full description on how to use `rsconnect bootstrap` in a provisioning workflow is provided in the Connect administrator guide's
 [programmatic provisioning](https://docs.posit.co/connect/admin/programmatic-provisioning) documentation.
 
 ## Server Administration Tasks

README.md

@@ -7,7 +7,7 @@
 }
 
 .md-header {
-    border-bottom: 1px solid rgba(0, 0, 0, 0.15) !important; 
+    border-bottom: 1px solid rgba(0, 0, 0, 0.15) !important;
 }
 
 @media only screen and (max-width: 76.1875em){
@@ -30,7 +30,7 @@
 }
 
 .md-tabs__item {
-  height: 1.75rem !important;
+  height: unset;
 }
 
 /* Search bar
@@ -45,7 +45,7 @@
     font-weight: bold;
 }
 
-/* Search bar - black palette 
+/* Search bar - black palette
 */
 
 [data-md-color-primary=black] .md-search-result mark {
@@ -149,14 +149,19 @@
     color: #6F6B6B;
     font-weight: 400;
     font-size: 0.65rem;
-    padding-top: 15px;
+    clear: right;
 }
 
 .md-footer-meta.md-typeset a {
     color: #6F6B6B !important;
     font-weight: 400;
 }
 
+.md-footer-meta img {
+    margin-top: 4px;
+    height: 1em;
+}
+
 /* footer - black palette
 */
 
@@ -222,6 +227,7 @@
     padding: 0;
 }
 
+
 h2.divider {
     text-align: center;
     max-width: 650px;
@@ -298,7 +304,7 @@ pre code::-webkit-scrollbar-thumb:hover, .codehilite pre::-webkit-scrollbar-thum
         opacity: 0;
         pointer-events: none;
       }
-    
+
       // Back-to-top button on focus/hover
       &:focus,
       &:hover {