Skip to content

docs (sunbase-py) updated setup instructions, PR guidelines, added resources & links #690

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.

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 3 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,16 @@ In the interest of fostering an open and welcoming environment, please review an
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. After filing a pull request, please tag any two of the [current maintainers](./MAINTAINERS.md) to request a review.

## Report an issue
## Report an issue/File a feature request
Before opening a new issue or request, please take a moment to check the existing issues and discussions to see if your topic has already been addressed. This helps us avoid duplicate issues and keeps the conversation focused.

Report all issues through [GitHub Issues](./issues).

## File a feature request

File your feature request through [GitHub Issues](./issues).
Report all issues and file all feature requests through [GitHub Issues](./issues).

## Create a pull request

When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features:

- Before creating a pull request, file a GitHub Issue so that maintainers and the community can discuss the problem and potential solutions before you spend time on an implementation.
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change.
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change. To link to an existing issue or pull request in your PR, use the # symbol followed by the issue or PR number. For example, to link to issue number 123, you would write #123 in your PR's description. GitHub will automatically create a link to the issue.
- For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
- For example, if you update documentation for a specific extension, your commit message might be: `docs(extension-name) updated installation documentation`.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,28 @@ Python client for [Supabase](https://supabase.com)
- [GitHub OAuth in your Python Flask app](https://supabase.com/blog/oauth2-login-python-flask-apps)
- [Python data loading with Supabase](https://supabase.com/blog/loading-data-supabase-python)

## Installation
## Set up a Local Development Environment
### Clone the Repository:

We recommend activating your virtual environment. For example, we like `poetry` and `conda`!
```bash
git clone https://github.com/supabase-community/supabase-py.git
cd supabase-py
```

### Create and Activate a Virtual Environment:

We recommend activating your virtual environment. For example, we like `poetry` and `conda`! Click <a href="https://docs.python.org/3/library/venv.html">here</a> for more about Python virtual environments and working with <a href="https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#activating-an-environment">conda</a> and <a href="https://python-poetry.org/docs/basic-usage/">poetry</a>.

Using venv (Python 3 built-in):
```bash
python3 -m venv env
source env/bin/activate # On Windows, use .\env\Scripts\activate
```
Using conda:
```bash
conda create --name supabase-py
conda activate supabase-py
```

### PyPi installation

Expand Down Expand Up @@ -186,7 +205,7 @@ Overall Tasks:

## Contributing

Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on Discord if you want to get involved.
Contributing to the Python libraries are a great way to get involved with the Supabase community. Reach out to us on <a href="https://discord.supabase.com/">Discord</a> or on our <a href="https://github.com/orgs/supabase/discussions">Github Discussions</a> page if you want to get involved.

### Running Tests

Expand Down