Skip to content

Update intro.md #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 23, 2022
Merged

Update intro.md #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bc98bb6
Update intro.md
kellobri Jun 17, 2022
a71c1ea
ci: do not run gcs tests on fork pr
machow Jun 23, 2022
75dca78
docs: remove mention of unimplemented boards
machow Jun 23, 2022
5d9f4c2
docs: fix board_gcs docstring saying S3
machow Jun 23, 2022
4379b93
ci: do not try to push preview docs on fork
machow Jun 23, 2022
94801f7
ci: fix typo in workflow
machow Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ jobs:
- name: Run tests
run: |
# TODO: better way to disable all cloud backend tests?
pytest pins -m 'not fs_rsc and not fs_s3 and not skip_on_github'
pytest pins -m 'not fs_rsc and not fs_s3 and not fs_gcs and not skip_on_github'


check-cross-compatibility:
Expand Down Expand Up @@ -183,7 +183,8 @@ jobs:
name: "Preview Docs:"
runs-on: ubuntu-latest
needs: ["build-docs"]
if: github.event_name == 'pull_request'
if: "${{github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork }}"

steps:
- uses: actions/download-artifact@v3
with:
Expand Down
6 changes: 3 additions & 3 deletions docs/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ kernelspec:
:alt: pins, a library for organizing and sharing data.
```

The pins package publishes data, models, and other R 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, Amazon S3, Azure storage and ~~Microsoft 365 (OneDrive and SharePoint)~~.
The pins package publishes data, models, and other Python objects, making it easy to share
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, and Google Cloud Storage.
Pins can be automatically versioned, making it straightforward to track changes, re-run analyses on historical data, and undo mistakes.

## Installation
Expand Down Expand Up @@ -96,5 +96,5 @@ board.pin_read("hadley/sales-summary")

You can easily control who gets to access the data using the RStudio Connect permissions pane.

The pins package also includes boards that allow you to share data on services like Amazon's S3 (`board_s3()`) and Azure's blob storage (`board_azure()`).
The pins package also includes boards that allow you to share data on services like Amazon's S3 (`board_s3()`) and Google Cloud Storage (`board_gcs()`).
Learn more in [getting started](getting_started.Rmd).
2 changes: 1 addition & 1 deletion pins/constructors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ def board_s3(path, versioned=True, cache=DEFAULT, allow_pickle_read=None):


def board_gcs(path, versioned=True, cache=DEFAULT, allow_pickle_read=None):
"""Create a board to read and write pins from an AWS S3 bucket folder.
"""Create a board to read and write pins from an Google Cloud Storage bucket folder.

Parameters
----------
Expand Down