reflex-google-auth 0.0.3__tar.gz → 0.0.5__tar.gz

reflex-google-auth-0.0.5/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: reflex-google-auth
+Version: 0.0.5
+Summary: Sign in with Google
+Author-email: Masen Furer <m_github@0x26.net>
+License: Apache-2.0
+Project-URL: homepage, https://github.com/masenf/reflex-google-auth
+Keywords: reflex,reflex-custom-components
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: reflex>=0.4.6
+Requires-Dist: google-auth[requests]
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# google-auth
+
+Sign in with Google.
+
+## Installation
+
+```bash
+pip install reflex-google-auth
+```
+
+## Usage
+
+### Create Google OAuth2 Client ID
+
+Head over to https://console.developers.google.com/apis/credentials and sign in with the Google account that should manage the app and credential tokens.
+
+- Click "Create Project" and give it a name. After creation the new project should be selected.
+- Click "Configure Consent Screen", Choose "External", then Create.
+  - Enter App Name and User Support Email -- these will be shown to users when logging in
+  - Scroll all the way down to "Developer contact information" and add your email address, click "Save and Continue"
+  - Click "Add or Remove Scopes"
+    - Select "Email", "Profile", and "OpenID Connect"
+    - Click "Update", then "Save and Continue"
+  - Add any test users that should be able to log in during development.
+- From the "Credentials" page, click "+ Create Credentials", then "OAuth client ID"
+  - Select Application Type: "Web Application"
+  - Add Authorized Javascript Origins: http://localhost, http://localhost:3000, https://example.com (prod domain must be HTTPS)
+  - Click "Save"
+- Copy the OAuth "Client ID" and save it for later. Mine looks like 309209880368-4uqd9e44h7t4alhhdqn48pvvr63cc5j5.apps.googleusercontent.com
+
+https://github.com/reflex-dev/reflex-examples/assets/1524005/af2499a6-0bda-4d60-b52b-4f51b7322fd5
+
+### Integrate with Reflex app
+
+The `GoogleAuthState` provided by this component has a `token_is_valid` var that
+should be checked before returning any protected content.
+
+Additionally the `GoogleAuthState.tokeninfo` dict contains the user's profile information.
+
+```python
+from reflex_google_auth import GoogleAuthState, require_google_login
+
+
+class State(GoogleAuthState):
+    @rx.cached_var
+    def protected_content(self) -> str:
+        if self.token_is_valid:
+            return f"This content can only be viewed by a logged in User. Nice to see you {self.tokeninfo['name']}"
+        return "Not logged in."
+```
+
+The convenience decorator, `require_google_login`, can wrap an existing component, and
+show the "Sign in with Google" button if the user is not already authenticated. It can be
+used on a page function or any subcomponent function of the page.
+
+The "Sign in with Google" button can also be displayed via `google_login()`:
+
+```python
+from reflex_google_auth import google_login, google_oauth_provider
+
+def page():
+    return rx.div(
+        google_oauth_provider(
+            google_login(),
+        ),
+    )
+```
+
+To uniquely identify a user, the `GoogleAuthState.tokeninfo['sub']` field can be used.
+
+See the example in
+[masenf/rx_shout](https://github.com/masenf/rx_shout/blob/main/rx_shout/state.py)
+for how to integrate an authenticated Google user with other app-specific user
+data.

reflex-google-auth-0.0.5/README.md

@@ -0,0 +1,74 @@
+# google-auth
+
+Sign in with Google.
+
+## Installation
+
+```bash
+pip install reflex-google-auth
+```
+
+## Usage
+
+### Create Google OAuth2 Client ID
+
+Head over to https://console.developers.google.com/apis/credentials and sign in with the Google account that should manage the app and credential tokens.
+
+- Click "Create Project" and give it a name. After creation the new project should be selected.
+- Click "Configure Consent Screen", Choose "External", then Create.
+  - Enter App Name and User Support Email -- these will be shown to users when logging in
+  - Scroll all the way down to "Developer contact information" and add your email address, click "Save and Continue"
+  - Click "Add or Remove Scopes"
+    - Select "Email", "Profile", and "OpenID Connect"
+    - Click "Update", then "Save and Continue"
+  - Add any test users that should be able to log in during development.
+- From the "Credentials" page, click "+ Create Credentials", then "OAuth client ID"
+  - Select Application Type: "Web Application"
+  - Add Authorized Javascript Origins: http://localhost, http://localhost:3000, https://example.com (prod domain must be HTTPS)
+  - Click "Save"
+- Copy the OAuth "Client ID" and save it for later. Mine looks like 309209880368-4uqd9e44h7t4alhhdqn48pvvr63cc5j5.apps.googleusercontent.com
+
+https://github.com/reflex-dev/reflex-examples/assets/1524005/af2499a6-0bda-4d60-b52b-4f51b7322fd5
+
+### Integrate with Reflex app
+
+The `GoogleAuthState` provided by this component has a `token_is_valid` var that
+should be checked before returning any protected content.
+
+Additionally the `GoogleAuthState.tokeninfo` dict contains the user's profile information.
+
+```python
+from reflex_google_auth import GoogleAuthState, require_google_login
+
+
+class State(GoogleAuthState):
+    @rx.cached_var
+    def protected_content(self) -> str:
+        if self.token_is_valid:
+            return f"This content can only be viewed by a logged in User. Nice to see you {self.tokeninfo['name']}"
+        return "Not logged in."
+```
+
+The convenience decorator, `require_google_login`, can wrap an existing component, and
+show the "Sign in with Google" button if the user is not already authenticated. It can be
+used on a page function or any subcomponent function of the page.
+
+The "Sign in with Google" button can also be displayed via `google_login()`:
+
+```python
+from reflex_google_auth import google_login, google_oauth_provider
+
+def page():
+    return rx.div(
+        google_oauth_provider(
+            google_login(),
+        ),
+    )
+```
+
+To uniquely identify a user, the `GoogleAuthState.tokeninfo['sub']` field can be used.
+
+See the example in
+[masenf/rx_shout](https://github.com/masenf/rx_shout/blob/main/rx_shout/state.py)
+for how to integrate an authenticated Google user with other app-specific user
+data.

{reflex-google-auth-0.0.3 → reflex-google-auth-0.0.5}/custom_components/reflex_google_auth/google_auth.py

@@ -22,8 +22,7 @@ class GoogleLogin(rx.Component):
     library = "@react-oauth/google"
     tag = "GoogleLogin"
 
-    def get_event_triggers(self):
-        return {"on_success": lambda data: [data]}
+    on_success: rx.EventHandler[lambda data: [data]]
 
     @classmethod
     def create(cls, **props) -> "GoogleLogin":

reflex-google-auth-0.0.5/custom_components/reflex_google_auth.egg-info/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: reflex-google-auth
+Version: 0.0.5
+Summary: Sign in with Google
+Author-email: Masen Furer <m_github@0x26.net>
+License: Apache-2.0
+Project-URL: homepage, https://github.com/masenf/reflex-google-auth
+Keywords: reflex,reflex-custom-components
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: reflex>=0.4.6
+Requires-Dist: google-auth[requests]
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# google-auth
+
+Sign in with Google.
+
+## Installation
+
+```bash
+pip install reflex-google-auth
+```
+
+## Usage
+
+### Create Google OAuth2 Client ID
+
+Head over to https://console.developers.google.com/apis/credentials and sign in with the Google account that should manage the app and credential tokens.
+
+- Click "Create Project" and give it a name. After creation the new project should be selected.
+- Click "Configure Consent Screen", Choose "External", then Create.
+  - Enter App Name and User Support Email -- these will be shown to users when logging in
+  - Scroll all the way down to "Developer contact information" and add your email address, click "Save and Continue"
+  - Click "Add or Remove Scopes"
+    - Select "Email", "Profile", and "OpenID Connect"
+    - Click "Update", then "Save and Continue"
+  - Add any test users that should be able to log in during development.
+- From the "Credentials" page, click "+ Create Credentials", then "OAuth client ID"
+  - Select Application Type: "Web Application"
+  - Add Authorized Javascript Origins: http://localhost, http://localhost:3000, https://example.com (prod domain must be HTTPS)
+  - Click "Save"
+- Copy the OAuth "Client ID" and save it for later. Mine looks like 309209880368-4uqd9e44h7t4alhhdqn48pvvr63cc5j5.apps.googleusercontent.com
+
+https://github.com/reflex-dev/reflex-examples/assets/1524005/af2499a6-0bda-4d60-b52b-4f51b7322fd5
+
+### Integrate with Reflex app
+
+The `GoogleAuthState` provided by this component has a `token_is_valid` var that
+should be checked before returning any protected content.
+
+Additionally the `GoogleAuthState.tokeninfo` dict contains the user's profile information.
+
+```python
+from reflex_google_auth import GoogleAuthState, require_google_login
+
+
+class State(GoogleAuthState):
+    @rx.cached_var
+    def protected_content(self) -> str:
+        if self.token_is_valid:
+            return f"This content can only be viewed by a logged in User. Nice to see you {self.tokeninfo['name']}"
+        return "Not logged in."
+```
+
+The convenience decorator, `require_google_login`, can wrap an existing component, and
+show the "Sign in with Google" button if the user is not already authenticated. It can be
+used on a page function or any subcomponent function of the page.
+
+The "Sign in with Google" button can also be displayed via `google_login()`:
+
+```python
+from reflex_google_auth import google_login, google_oauth_provider
+
+def page():
+    return rx.div(
+        google_oauth_provider(
+            google_login(),
+        ),
+    )
+```
+
+To uniquely identify a user, the `GoogleAuthState.tokeninfo['sub']` field can be used.
+
+See the example in
+[masenf/rx_shout](https://github.com/masenf/rx_shout/blob/main/rx_shout/state.py)
+for how to integrate an authenticated Google user with other app-specific user
+data.

{reflex-google-auth-0.0.3 → reflex-google-auth-0.0.5}/custom_components/reflex_google_auth.egg-info/requires.txt

@@ -1,4 +1,4 @@
-reflex>=0.4.2
+reflex>=0.4.6
 google-auth[requests]
 
 [dev]

{reflex-google-auth-0.0.3 → reflex-google-auth-0.0.5}/pyproject.toml

@@ -7,18 +7,16 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "reflex-google-auth"
-version = "0.0.3"
-description = "Reflex custom component google-auth"
+version = "0.0.5"
+description = "Sign in with Google"
 readme = "README.md"
 license = { text = "Apache-2.0" }
 requires-python = ">=3.8"
 authors = [{ name = "Masen Furer", email = "m_github@0x26.net" }]
-keywords = [
-    "reflex",
-    "reflex-custom-components"]
+keywords = ["reflex", "reflex-custom-components"]
 
 dependencies = [
-    "reflex>=0.4.2",
+    "reflex>=0.4.6",
     "google-auth[requests]",
 ]
 
@@ -27,7 +25,7 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/martinxu9/reflex-google-auth"
+homepage = "https://github.com/masenf/reflex-google-auth"
 
 [project.optional-dependencies]
 dev = ["build", "twine"]

reflex-google-auth-0.0.3/PKG-INFO

@@ -1,26 +0,0 @@
-Metadata-Version: 2.1
-Name: reflex-google-auth
-Version: 0.0.3
-Summary: Reflex custom component google-auth
-Author-email: Masen Furer <m_github@0x26.net>
-License: Apache-2.0
-Project-URL: Homepage, https://github.com/martinxu9/reflex-google-auth
-Keywords: reflex,reflex-custom-components
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: reflex>=0.4.2
-Requires-Dist: google-auth[requests]
-Provides-Extra: dev
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-
-# google-auth
-
-A Reflex custom component google-auth.
-
-## Installation
-
-```bash
-pip install reflex-google-auth
-```

reflex-google-auth-0.0.3/README.md

@@ -1,9 +0,0 @@
-# google-auth
-
-A Reflex custom component google-auth.
-
-## Installation
-
-```bash
-pip install reflex-google-auth
-```

reflex-google-auth-0.0.3/custom_components/reflex_google_auth.egg-info/PKG-INFO

@@ -1,26 +0,0 @@
-Metadata-Version: 2.1
-Name: reflex-google-auth
-Version: 0.0.3
-Summary: Reflex custom component google-auth
-Author-email: Masen Furer <m_github@0x26.net>
-License: Apache-2.0
-Project-URL: Homepage, https://github.com/martinxu9/reflex-google-auth
-Keywords: reflex,reflex-custom-components
-Classifier: Development Status :: 4 - Beta
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: reflex>=0.4.2
-Requires-Dist: google-auth[requests]
-Provides-Extra: dev
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
-
-# google-auth
-
-A Reflex custom component google-auth.
-
-## Installation
-
-```bash
-pip install reflex-google-auth
-```