| Name | reflex-clerk-custom JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Reflex custom component library for Clerk, a user management platform. Updated for Reflex 0.6.0 |
| upload_time | 2024-11-04 19:33:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
reflex
reflex-custom-components
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# clerk
A Reflex custom component clerk. [Updated for Reflex 0.6.0+]
## Installation
```bash
pip install reflex-clerk
```
## Usage
```python
import reflex as rx
from reflex_clerk import clerk_provider, sign_in_button, install_signin_page
publishable_key = "your_clerk_publishable_key"
def index() -> rx.Component:
return clerk_provider(
rx.vstack(
sign_in_button(),
align="center",
spacing="7",
),
publishable_key=publishable_key,
)
app = rx.App()
app.add_page(index)
install_signin_page(app)
```
In this example:
1. We import the necessary components from Reflex and the `reflex_clerk` library.
2. We define the `publishable_key` for our Clerk instance.
3. We create a function index that returns a Reflex component.
4. Inside the index function, we use the `clerk_provider` component from reflex_clerk. This component sets up the Clerk
context for the rest of the components within it.
5. Within the `clerk_provider`, we create a vertical stack (rx.vstack) that contains the sign_in.sign_in_button()
component from reflex_clerk. This component renders a sign-in button for Clerk.
6. We pass the `publishable_key` to the `clerk_provider` component.
With this setup, you'll have a page that displays a sign-in button powered by Clerk. You can then add more Clerk
components, such as user profile information, sign-out buttons, and more, within the clerk_provider.
Further documentation can be found in [the reference docs](docs/)
## Build
Suggest using a virtual environment
1. `pip install -r requirements.txt`
2. `pip install .[dev]`
3. `python -m build`
## License
Apache-2.0
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Acknowledgments
- [Reflex](https://github.com/reflexjs/reflex)
- [Clerk](https://clerk.dev/)
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-clerk-custom",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components",
"author": null,
"author_email": "Elliot Kroo <elliot@kroo.net>",
"download_url": "https://files.pythonhosted.org/packages/56/92/57833333017ab8fb1702eb4722e7d957df2c33b4ead19b43bb90876c0c6d/reflex_clerk_custom-1.0.4.tar.gz",
"platform": null,
"description": "# clerk\n\nA Reflex custom component clerk. [Updated for Reflex 0.6.0+]\n\n## Installation\n\n```bash\npip install reflex-clerk\n```\n\n## Usage\n\n```python\nimport reflex as rx\nfrom reflex_clerk import clerk_provider, sign_in_button, install_signin_page\n\npublishable_key = \"your_clerk_publishable_key\"\n\n\ndef index() -> rx.Component:\n return clerk_provider(\n rx.vstack(\n sign_in_button(),\n align=\"center\",\n spacing=\"7\",\n ),\n publishable_key=publishable_key,\n )\n\n\napp = rx.App()\napp.add_page(index)\ninstall_signin_page(app)\n```\n\nIn this example:\n\n1. We import the necessary components from Reflex and the `reflex_clerk` library.\n2. We define the `publishable_key` for our Clerk instance.\n3. We create a function index that returns a Reflex component.\n4. Inside the index function, we use the `clerk_provider` component from reflex_clerk. This component sets up the Clerk\n context for the rest of the components within it.\n5. Within the `clerk_provider`, we create a vertical stack (rx.vstack) that contains the sign_in.sign_in_button()\n component from reflex_clerk. This component renders a sign-in button for Clerk.\n6. We pass the `publishable_key` to the `clerk_provider` component.\n\nWith this setup, you'll have a page that displays a sign-in button powered by Clerk. You can then add more Clerk\ncomponents, such as user profile information, sign-out buttons, and more, within the clerk_provider.\n\nFurther documentation can be found in [the reference docs](docs/)\n\n## Build\nSuggest using a virtual environment\n\n1. `pip install -r requirements.txt`\n2. `pip install .[dev]`\n3. `python -m build`\n\n## License\n\nApache-2.0\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## Acknowledgments\n\n- [Reflex](https://github.com/reflexjs/reflex)\n- [Clerk](https://clerk.dev/)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Reflex custom component library for Clerk, a user management platform. Updated for Reflex 0.6.0",
"version": "1.0.4",
"project_urls": {
"homepage": "https://github.com/gururise/reflex-clerk",
"source": "https://github.com/gururise/reflex-clerk"
},
"split_keywords": [
"reflex",
" reflex-custom-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "096f58e0fe8472c79c5ccf3edf7958091b6b35ad2ced558c4fb3b1d662b96458",
"md5": "3ccb539786ede6a2d37b5ffbbd616b60",
"sha256": "b338f8126d1f3e18dd18ba86ebd6822f93bf4f998f8da1ad3763280ae04af8cb"
},
"downloads": -1,
"filename": "reflex_clerk_custom-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ccb539786ede6a2d37b5ffbbd616b60",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 24507,
"upload_time": "2024-11-04T19:33:52",
"upload_time_iso_8601": "2024-11-04T19:33:52.159717Z",
"url": "https://files.pythonhosted.org/packages/09/6f/58e0fe8472c79c5ccf3edf7958091b6b35ad2ced558c4fb3b1d662b96458/reflex_clerk_custom-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "569257833333017ab8fb1702eb4722e7d957df2c33b4ead19b43bb90876c0c6d",
"md5": "5da4eea557d29980ef28d42aaa7738c8",
"sha256": "76357528569ab4a2262cd4989285db8254b36186082f11ac928ff4d900a8aa33"
},
"downloads": -1,
"filename": "reflex_clerk_custom-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5da4eea557d29980ef28d42aaa7738c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19171,
"upload_time": "2024-11-04T19:33:53",
"upload_time_iso_8601": "2024-11-04T19:33:53.803982Z",
"url": "https://files.pythonhosted.org/packages/56/92/57833333017ab8fb1702eb4722e7d957df2c33b4ead19b43bb90876c0c6d/reflex_clerk_custom-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 19:33:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gururise",
"github_project": "reflex-clerk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "reflex-clerk-custom"
}
