posit-sdk 0.0.dev0__tar.gz

posit-sdk-0.0.dev0/.coveragerc

@@ -0,0 +1,2 @@
+[report]
+    fail_under = 80

posit-sdk-0.0.dev0/.github/workflows/main.yaml

@@ -0,0 +1,24 @@
+name: Main
+on:
+  push:
+    branches:
+      - main
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: make
+    - run: make install

posit-sdk-0.0.dev0/.github/workflows/pull-request.yaml

@@ -0,0 +1,46 @@
+name: Pull Request
+on:
+  pull_request:
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.8'
+          - '3.9'
+          - '3.10'
+          - '3.11'
+          - '3.12'
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: make deps
+    - run: make test
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - run: make deps
+    - run: make lint
+  cov:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - run: make deps
+    - run: make test
+    - run: make cov-xml
+    - if: always()
+      uses: orgoro/coverage@v3.1
+      with:
+          coverageFile: coverage.xml
+          thresholdAll: 0.8
+          token: ${{ secrets.GITHUB_TOKEN }}

posit-sdk-0.0.dev0/.github/workflows/release.yaml

@@ -0,0 +1,16 @@
+name: Release
+on:
+  push:
+    tags:
+      - "v*.*.*"
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - run: make
+    - id: release
+      uses: pypa/gh-action-pypi-publish@release/v1

posit-sdk-0.0.dev0/.gitignore

@@ -0,0 +1,168 @@
+*.orig
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Version file
+/src/posit/_version.py
+
+# Ruff
+.ruff_cache/

posit-sdk-0.0.dev0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: local
+    hooks:
+      - id: format
+        name: format
+        entry: bash -c "make fmt"
+        language: system
+      - id: lint
+        name: lint
+        entry: bash -c "make lint"
+        language: system

posit-sdk-0.0.dev0/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": true
+        }
+    ]
+}

posit-sdk-0.0.dev0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "src"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

posit-sdk-0.0.dev0/CONTRIBUTING.md

@@ -0,0 +1,126 @@
+# Contributing
+
+## Overview
+
+The `posit-sdk` is a software development kit (SDK) designed to facilitate the development of projects using the Posit framework. This document provides instructions on how to use the provided `Makefile` to perform various tasks such as building, testing, linting, and installing the SDK.
+
+## Prerequisites
+
+Before contributing to the `posit-sdk`, ensure that the following prerequisites are met:
+
+- Python 3.x is installed on your system.
+- `pip3` is installed to manage Python packages.
+- `make` utility is installed (commonly available on Unix-like systems).
+
+## Project Structure
+
+The the following files are commonly used during development.
+
+- `Makefile`: Contains various commands to build, test, lint, and install the SDK.
+- `requirements.txt`: Lists the required Python dependencies for the SDK.
+- `requirements-dev.txt`: Lists additional dependencies required for development and testing purposes.
+- `src/`: Contains the source code of the SDK.
+
+## Tooling
+
+The `Makefile` provides the following commands:
+
+- `build`: Build the SDK.
+- `clean`: Remove generated files and directories.
+- `cov`: Generate coverage report.
+- `cov-html`: Generate HTML coverage report.
+- `cov-xml`: Generate XML coverage report.
+- `deps`: Install required dependencies.
+- `fmt`: Format the source code.
+- `install`: Install the SDK locally.
+- `lint`: Perform linting using `mypy` and `ruff`.
+- `test`: Run tests with coverage.
+- `uninstall`: Uninstall the SDK.
+- `version`: Display the current version of the SDK.
+
+## Release
+
+### Instructions
+
+To start a release create a semver compatible tag.
+
+_For this example, we will use the tag `v0.0.dev0`. This tag already exists, so you will not be able run the following commands verbatim._
+
+
+**Step 1**
+
+Create a proper SemVer compatible tag. Consult the [SemVer specification](https://semver.org/spec/v2.0.0.html) if you are unsure what this means.
+
+`git tag v0.0.dev0`
+
+**Step 2**
+
+Push the tag GitHub.
+
+`git push origin v0.0.dev0`
+
+This command will trigger the [Release GitHub Action](https://github.com/posit-dev/posit-sdk-py/actions/workflows/release.yaml).
+
+**Step 3**
+
+Once complete the action has completed, the release will be available on the [Releases page](https://github.com/posit-dev/posit-sdk-py/releases).
+
+### Pre-Releases
+
+Any tags denoted as a pre-release as defined by the [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) specification will be marked as such in GitHub. For example, the `v0.0.dev0` is a pre-release. Tag `v0.0.0` is a standard-release. Please consult the specification for additional information.
+
+[PEP-440](https://peps.python.org/pep-0440/#summary-of-permitted-suffixes-and-relative-ordering) provides a good example of common pre-release tag combinations.
+
+For additional definitions see https://en.wikipedia.org/wiki/Software_release_life_cycle.
+
+Currently, the following suffix lineage is in use:
+
+### Release Lifecycle
+
+- `X`: The major version.
+- `Y`: The minor version.
+- `Z`: The patch version.
+- `N`: A variable representing the incremental version value.
+
+**`X.Y.devN`**
+
+A development pre-release. Created to test changes to the release procces. `N` starts at **0** and increments by 1 (`X.Y.dev0`, `X.Y.dev1`, ..., `X.Y.devN`).
+
+*https://peps.python.org/pep-0440/#implicit-development-release-number*
+
+**`X.Y.alphaN`**
+
+An alpha pre-release. Created to support internal user testing. `N` starts at **1** and increments by 1 (`X.Y.alpha1`, `X.Y.alpha2`, ..., `X.Y.alphaN`).
+
+*https://peps.python.org/pep-0440/#pre-releases*
+
+**`X.Y.betaN`**
+
+An beta pre-release. Created to support closed external user testing. `N` starts at **1** and increments by 1 (`X.Y.beta1`, `X.Y.beta2`, ..., `X.Y.betaN`).
+
+*https://peps.python.org/pep-0440/#pre-releases*
+
+
+**`X.Y.rcN`**
+
+An release-candidate pre-release. Created to support open external user testing. `N` starts at **1** and increments by 1 (`X.Y.rc1`, `X.Y.rc2`, ..., `X.Y.rcN`).
+
+*https://peps.python.org/pep-0440/#pre-releases*
+
+**`X.Y.N`**
+
+A stable patch release. Created for backward compatible bug fixes. `N` starts at **0** and increments by 1 (`X.Y.0`, `X.Y.1`, ..., `X.Y.N`).
+
+*https://semver.org*
+
+**`X.N.Z`**
+
+A stable minor release. Created for added functionality in a backward compatible manner. `N` starts at **0** and increments by 1 (`X.0.Z`, `X.1.Z`, ..., `X.N.Z`).
+
+*https://semver.org*
+
+**`N.Y.Z`**
+
+A stable major release. Created for incompatbile API changes. `N` starts at **0** and increments by 1 (`0.Y.Z`, `1.Y.Z`, ..., `N.Y.Z`).
+
+*https://semver.org*

posit-sdk-0.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 posit-dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

posit-sdk-0.0.dev0/Makefile

@@ -0,0 +1,62 @@
+NAME := posit-sdk
+PIP := pip3
+PYTHON := python3
+
+.PHONY:
+	build
+	clean
+	cov
+	default
+	deps
+	fmt
+	install
+	lint
+	test
+	uninstall
+	version
+
+default:
+	make deps
+	make test
+	make lint
+	make build
+
+build:
+	$(PYTHON) -m build
+
+clean:
+	find . -name "*.egg-info" -exec rm -rf {} +
+	find . -name "*.pyc" -exec rm -f {} +
+	find . -name "__pycache__" -exec rm -rf {} +
+	rm -rf .coverage .mypy_cache .pytest_cache .ruff_cache *.egg-info build dist htmlcov
+
+cov:
+	$(PYTHON) -m coverage report
+
+cov-html:
+	$(PYTHON) -m coverage html
+
+cov-xml:
+	$(PYTHON) -m coverage xml
+
+deps:
+	$(PIP) install -r requirements.txt -r requirements-dev.txt
+
+fmt:
+	$(PYTHON) -m ruff format .
+
+install:
+	$(PIP) install -e .
+
+lint:
+	$(PYTHON) -m mypy --install-types --non-interactive .
+	$(PYTHON) -m ruff check
+
+test:
+	$(PYTHON) -m coverage run --source=src --omit=_version.py -m pytest
+
+uninstall:
+	$(PIP) uninstall -y $(NAME)
+
+version:
+	$(PYTHON) -m setuptools_scm

posit-sdk-0.0.dev0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: posit-sdk
+Version: 0.0.dev0
+Summary: Posit SDK for Python
+License: MIT License
+        
+        Copyright (c) 2024 posit-dev
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Source, https://github.com/posit-dev/posit-sdk-py
+Project-URL: Issues, https://github.com/posit-dev/posit-sdk-py/issues
+Keywords: posit,sdk
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3,>=2.31.0
+
+# Posit SDK for Python
+
+This package provides a Pythonic interface for developers to work against the public APIs of Posit's professional products. It is intended to be lightweight yet expressive.
+
+> The Posit SDK is in the very early stages of development, and currently only Posit Connect has any support. 
+
+## Installation
+
+```shell
+pip install posit-sdk
+```
+
+## Usage
+
+```python
+from posit.connect import Client
+
+# If CONNECT_API_KEY and CONNECT_SERVER are set in your environment,
+# they will be picked up, or you can pass them as arguments
+con = Client()
+con.users.find()
+```
+
+<!-- Add notes about local development -->
+
+<!-- Add code of conduct -->

posit-sdk-0.0.dev0/README.md

@@ -0,0 +1,26 @@
+# Posit SDK for Python
+
+This package provides a Pythonic interface for developers to work against the public APIs of Posit's professional products. It is intended to be lightweight yet expressive.
+
+> The Posit SDK is in the very early stages of development, and currently only Posit Connect has any support. 
+
+## Installation
+
+```shell
+pip install posit-sdk
+```
+
+## Usage
+
+```python
+from posit.connect import Client
+
+# If CONNECT_API_KEY and CONNECT_SERVER are set in your environment,
+# they will be picked up, or you can pass them as arguments
+con = Client()
+con.users.find()
+```
+
+<!-- Add notes about local development -->
+
+<!-- Add code of conduct -->

posit-sdk-0.0.dev0/examples/connect/.gitignore

@@ -0,0 +1 @@
+.posit

posit-sdk-0.0.dev0/examples/connect/databricks/README.md

@@ -0,0 +1,19 @@
+```bash
+# start streamlit locally
+DATABRICKS_TOKEN=<DB_PAT> \
+streamlit run ./sample-content.py
+
+# deploy the app the first time
+publisher deploy -a localhost:3939 -n databricks ./
+
+# re-deploy the databricks app
+publisher redeploy databricks
+```
+
+TODO: Test this content with databricks-connect
+<https://docs.databricks.com/en/dev-tools/databricks-connect/python/index.html>
+
+```
+# install the sdk from this branch
+pip install git+https://github.com/posit-dev/posit-sdk-py.git@kegs/databricks-oauth-2
+```

posit-sdk-0.0.dev0/examples/connect/databricks/requirements.txt

@@ -0,0 +1,56 @@
+altair==5.2.0
+attrs==23.2.0
+blinker==1.7.0
+cachetools==5.3.2
+certifi==2024.2.2
+charset-normalizer==3.3.2
+click==8.1.7
+databricks-sdk==0.20.0
+databricks-sql-connector==3.1.0
+et-xmlfile==1.1.0
+gitdb==4.0.11
+GitPython==3.1.42
+google-auth==2.28.0
+idna==3.6
+importlib-metadata==7.0.1
+Jinja2==3.1.3
+jsonschema==4.21.1
+jsonschema-specifications==2023.12.1
+lz4==4.3.3
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
+mdurl==0.1.2
+numpy==1.26.4
+oauthlib==3.2.2
+openpyxl==3.1.2
+packaging==23.2
+pandas==2.1.4
+pillow==10.2.0
+posit-sdk @ git+https://github.com/posit-dev/posit-sdk-py.git@24ad71458de56b01b8168e80441ea860236f1933
+protobuf==4.25.3
+pyarrow==14.0.2
+pyasn1==0.5.1
+pyasn1-modules==0.3.0
+pydeck==0.8.1b0
+Pygments==2.17.2
+python-dateutil==2.8.2
+pytz==2024.1
+referencing==0.33.0
+requests==2.31.0
+rich==13.7.0
+rpds-py==0.18.0
+rsa==4.9
+six==1.16.0
+smmap==5.0.1
+streamlit==1.31.1
+tenacity==8.2.3
+thrift==0.16.0
+toml==0.10.2
+toolz==0.12.1
+tornado==6.4
+typing_extensions==4.9.0
+tzdata==2024.1
+tzlocal==5.2
+urllib3==2.2.1
+validators==0.22.0
+zipp==3.17.0