Merge pull request #99 from rstudio/ci-deploy-pypi

Ci deploy pypi

Author: machow

.github/workflows/ci.yml

@@ -159,3 +159,25 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: docs-html
+
+  release-pypi:
+    name: "Release to pypi"
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    needs: [build-docs, tests, test-rsconnect]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: "Build Package"
+        run: |
+          python -m pip install build wheel
+          python -m build --sdist --wheel
+
+      - name: "Deploy to Test PyPI"
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          repository_url: https://pypi.org/legacy/

MANIFEST.in

@@ -1 +1,2 @@
-include pins/data/*.csv
+prune .*
+prune docs

README.md

@@ -2,13 +2,25 @@
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/machow/pins-python/HEAD)
 
-## Install
+The pins package publishes data, models, and other python objects, making it
+easy to share them across projects and with your colleagues. You can pin
+objects to a variety of pin *boards*, including folders (to share on a
+networked drive or with services like DropBox), RStudio Connect, and Amazon
+S3.
+Pins can be automatically versioned, making it straightforward to track changes,
+re-run analyses on historical data, and undo mistakes.
+
+## Installation
 
 ```shell
-python -m pip install git+https://github.com/machow/pins-python
+python -m pip install pins
 ```
 
-## Develop
+## Usage
+
+See the [documentation](https://rstudio.github.io/pins-python) for getting started.
+
+## Development
 
 ### Install pins with dev dependencies
 

docs/intro.md

@@ -24,12 +24,12 @@ The pins package publishes data, models, and other R objects, making it easy to
 You can pin objects to a variety of pin *boards*, including folders (to share on a networked drive or with services like DropBox), RStudio Connect, Amazon S3, Azure storage and ~Microsoft 365 (OneDrive and SharePoint)~.
 Pins can be automatically versioned, making it straightforward to track changes, re-run analyses on historical data, and undo mistakes.
 
-## 🚧 Installation
+## Installation
 
 To try out the development version of pins you'll need to install from GitHub:
 
 ```shell
-python -m pip install git+https://github.com/machow/pins-python
+python -m pip install pins
 ```
 
 ## Usage

pins/tests/test_compat_old_types.py

@@ -0,0 +1,16 @@
+import pandas as pd
+
+from importlib_resources import files
+
+from pins import board_folder
+
+OLD_BOARD = files("pins") / "tests" / "pins-old-types"
+DST_DF = pd.DataFrame({"a": [1, 2], "b": ["x", "y"]})
+
+
+def test_compat_old_types_load_table():
+    board = board_folder(OLD_BOARD)
+    src_df = board.pin_read("a-table")
+
+    assert isinstance(src_df, pd.DataFrame)
+    assert src_df.equals(DST_DF)

setup.cfg

@@ -1,7 +1,6 @@
 [metadata]
 name = pins
-version = file: VERSION
-description = Publish data sets, models, and other R objects, making it easy to share them across projects and with your colleagues.
+description = Publish data sets, models, and other python objects, making it easy to share them across projects and with your colleagues.
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/machow/pins-python