# ogarantia-streamlit-card
Streamlit Component for a UI card - Adapted for Ogarantia applications.
Authors: [Wilder Lopes](https://github.com/wilderlopes) (wilder@ogarantia.com)
Based on the work by [@gamcoh](https://github.com/gamcoh) @Pernod Ricard
## Installation
### From pip
Install `ogarantia-streamlit-card` with pip
```bash
pip install ogarantia-streamlit-card
```
### From source
1. Build the react frontend
Go inside the frontend folder:
```
cd ogarantia_streamlit_card/frontend
```
Install npm packages (if you run into problems, just delete `package-lock.json`
and run the install command again):
```
npm install
```
Build the frontend:
```
npm run build
```
2. Build the python wheel
Go back to the project root and run (you might need to `pip install build` first):
```
python -m build .
```
This generates the folder `dist` that contains the python wheel. Finally,
```
pip install dist/*.whl
```
## Usage
Import the `card` function from `ogarantia-streamlit_card`
```py
from ogarantia_streamlit_card import card
hasClicked = card(
title="Hello World!",
text="Some description",
image="https://get.ogre.run/images/ogarantia_logoBlue.png"
url="https://github.com/Ogarantia/st-card"
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Ogarantia/st-card.git",
"name": "ogarantia-streamlit-card",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "card streamlit streamlit-component",
"author": "Wilder Lopes",
"author_email": "wilder@ogarantia.com",
"download_url": "https://files.pythonhosted.org/packages/8f/92/e1f4d26ba665929d40ab7d66922c6f90589d83fcf27e7a8d60205b24d684/ogarantia-streamlit-card-0.0.2.tar.gz",
"platform": null,
"description": "# ogarantia-streamlit-card\n\nStreamlit Component for a UI card - Adapted for Ogarantia applications.\n\nAuthors: [Wilder Lopes](https://github.com/wilderlopes) (wilder@ogarantia.com)\nBased on the work by [@gamcoh](https://github.com/gamcoh) @Pernod Ricard\n\n## Installation\n\n### From pip\n\nInstall `ogarantia-streamlit-card` with pip\n```bash\npip install ogarantia-streamlit-card\n```\n\n### From source\n\n1. Build the react frontend\n\nGo inside the frontend folder:\n\n```\ncd ogarantia_streamlit_card/frontend\n```\n\nInstall npm packages (if you run into problems, just delete `package-lock.json`\nand run the install command again):\n\n```\nnpm install\n```\n\nBuild the frontend:\n\n```\nnpm run build\n```\n\n2. Build the python wheel\n\nGo back to the project root and run (you might need to `pip install build` first):\n\n```\npython -m build .\n```\n\nThis generates the folder `dist` that contains the python wheel. Finally,\n\n```\npip install dist/*.whl\n```\n\n## Usage\n\nImport the `card` function from `ogarantia-streamlit_card`\n```py\nfrom ogarantia_streamlit_card import card\n\nhasClicked = card(\n title=\"Hello World!\",\n text=\"Some description\",\n image=\"https://get.ogre.run/images/ogarantia_logoBlue.png\"\n url=\"https://github.com/Ogarantia/st-card\"\n)\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "A streamlit component to make UI cards, adapted for Ogarantia applications from `streamlit-card` by gamcoh (cohengamliel8@gmail.com)",
"version": "0.0.2",
"split_keywords": [
"card",
"streamlit",
"streamlit-component"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c45ee4ac3df066eec86083e44fbc2be320bb82a441e8fb04ecf2926ae42f766",
"md5": "9008b7124ceb6ab5bad4ca53fd4f2359",
"sha256": "2c1b38f46b6656c72820da53f61a39745b9cf79fd6459c6a84eb557df16b875c"
},
"downloads": -1,
"filename": "ogarantia_streamlit_card-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9008b7124ceb6ab5bad4ca53fd4f2359",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 752666,
"upload_time": "2023-01-09T02:36:59",
"upload_time_iso_8601": "2023-01-09T02:36:59.565388Z",
"url": "https://files.pythonhosted.org/packages/4c/45/ee4ac3df066eec86083e44fbc2be320bb82a441e8fb04ecf2926ae42f766/ogarantia_streamlit_card-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f92e1f4d26ba665929d40ab7d66922c6f90589d83fcf27e7a8d60205b24d684",
"md5": "90626341de21e35b77be8c05e2a8f94e",
"sha256": "0949d4eab80ebdd33d06180c9cbc5066695dd18fcb5bf62fadc446048f196c90"
},
"downloads": -1,
"filename": "ogarantia-streamlit-card-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "90626341de21e35b77be8c05e2a8f94e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 743039,
"upload_time": "2023-01-09T02:37:02",
"upload_time_iso_8601": "2023-01-09T02:37:02.042771Z",
"url": "https://files.pythonhosted.org/packages/8f/92/e1f4d26ba665929d40ab7d66922c6f90589d83fcf27e7a8d60205b24d684/ogarantia-streamlit-card-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-09 02:37:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Ogarantia",
"github_project": "st-card.git",
"lcname": "ogarantia-streamlit-card"
}
JSON
