You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ In the interest of fostering an open and welcoming environment, please review an
10
10
11
11
All submissions, including submissions by project members, require review. We
12
12
use GitHub pull requests for this purpose. Consult
13
-
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
13
+
[GitHub Help](https://help.github.com/articles/about-pull-requests) for more
14
14
information on using pull requests.
15
15
16
16
## Report an issue
@@ -27,6 +27,6 @@ When making pull requests to the repository, make sure to follow these guideline
27
27
28
28
- 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.
29
29
- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change.
30
-
- For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
30
+
- For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) format.
31
31
- For example, if you update documentation for a specific extension, your commit message might be: `docs(extension-name) updated installation documentation`.
Copy file name to clipboardExpand all lines: README.md
+21-6Lines changed: 21 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,43 @@
1
1
# Gotrue-py
2
-
This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js/). The current status is that there is not complete feature pairity when compared with the js-client, but this something we are working on.
2
+
3
+
This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js). The current status is that there is not complete feature pairity when compared with the js-client, but this something we are working on.
3
4
4
5
## Installation
6
+
5
7
We are still working on making the go-true python library more user-friendly. For now here are some sparse notes on how to install the module
6
8
7
9
### Poetry
10
+
8
11
```bash
9
12
poetry add gotrue
10
13
```
11
14
12
15
### Pip
16
+
13
17
```bash
14
18
pip install gotrue
15
19
```
16
20
17
21
## Differences to the JS client
18
-
It should be noted there are differences to the [JS client](https://github.com/supabase/gotrue-js/). If you feel particulaly strongly about them and want to motivate a change, feel free to make a GitHub issue and we can discuss it there.
19
22
20
-
Firstly, feature pairity is not 100% with the [JS client](https://github.com/supabase/gotrue-js/). In most cases we match the methods and attributes of the [JS client](https://github.com/supabase/gotrue-js/) and api classes, but is some places (e.g for browser specific code) it didn't make sense to port the code line for line.
23
+
It should be noted there are differences to the [JS client](https://github.com/supabase/gotrue-js). If you feel particulaly strongly about them and want to motivate a change, feel free to make a GitHub issue and we can discuss it there.
24
+
25
+
Firstly, feature pairity is not 100% with the [JS client](https://github.com/supabase/gotrue-js). In most cases we match the methods and attributes of the [JS client](https://github.com/supabase/gotrue-js) and api classes, but is some places (e.g for browser specific code) it didn't make sense to port the code line for line.
21
26
22
-
There is also a divergence in terms of how errors are raised. In the [JS client](https://github.com/supabase/gotrue-js/), the errors are returned as part of the object, which the user can choose to process in whatever way they see fit. In this Python client, we raise the errors directly where they originate, as it was felt this was more Pythonic and adhered to the idioms of the language more directly.
27
+
There is also a divergence in terms of how errors are raised. In the [JS client](https://github.com/supabase/gotrue-js), the errors are returned as part of the object, which the user can choose to process in whatever way they see fit. In this Python client, we raise the errors directly where they originate, as it was felt this was more Pythonic and adhered to the idioms of the language more directly.
23
28
24
29
In JS we return the error, but in Python we just raise it.
30
+
25
31
```js
26
32
const { data, error } =client.sign_up(...)
27
33
```
28
34
29
-
The other key difference is we do not use pascalCase to encode variable and method names. Instead we use the snake_case convention adopted in the Python language.
35
+
The other key difference is we do not use pascalCase to encode variable and method names. Instead we use the snake_case convention adopted in the Python language.
30
36
31
37
## Usage
38
+
32
39
To instanciate the client, you'll need the URL and any request headers at a minimum.
0 commit comments