# highlight-io Python SDK
This directory contains the source code for the Highlight Python SDK.
### E2E
The `e2e` directory contains supported Python frameworks integrated with our SDK for local development and testing.
Do not use the snippets verbatim as they are configured for local development and will not work in production without changes.
## Install
* Install [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
* `poetry install --all-extras`
## Run e2e apps
### Django
* `cd e2e/highlight_django`
* `poetry run python manage.py runserver`
### Flask
* `cd e2e/highlight_flask`
* `poetry run flask run`
### Fastapi
Start Redis:
* `cd docker`
* `./start_infra` (in order to start Redis)
Using Boto/Boto3 endpoints:
* Update the have the following environment variables (edit Run Confirguration in PyCharm)
* `E2E_AWS_ACCESS_KEY` (from IAM account)
* `E2E_AWS_SECRET_KEY` (from IAM account)
* `SQS_QUEUE_URL` (from SQS queue information)
Running the main app:
* `cd e2e/highlight_fastapi`
* `poetry run uvicorn main:app`
Running Celery worker:
* `cd e2e/highlight_fastapi`
* `poetry run celery -A e2e.highlight_fastapi.work worker --loglevel=INFO`
### Loguru
* `cd e2e/highlight_loguru`
* `poetry run python main.py`
## Run tests
* `poetry run pytest`
## Lint
* `poetry run black .`
Raw data
{
"_id": null,
"home_page": "https://www.highlight.io",
"name": "highlight-io",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "web, framework",
"author": "Vadim Korolik",
"author_email": "vadim@highlight.io",
"download_url": "https://files.pythonhosted.org/packages/5c/11/54205ddaba8f52c3328f57be124646a440bf7a2adaeda7c68c1fc92e2d09/highlight_io-0.7.0.tar.gz",
"platform": null,
"description": "# highlight-io Python SDK\n\nThis directory contains the source code for the Highlight Python SDK.\n\n### E2E\n\nThe `e2e` directory contains supported Python frameworks integrated with our SDK for local development and testing.\nDo not use the snippets verbatim as they are configured for local development and will not work in production without changes.\n\n\n## Install\n\n* Install [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)\n* `poetry install --all-extras`\n\n## Run e2e apps\n\n### Django\n\n* `cd e2e/highlight_django`\n* `poetry run python manage.py runserver`\n\n### Flask\n\n* `cd e2e/highlight_flask`\n* `poetry run flask run`\n\n### Fastapi\n\nStart Redis:\n* `cd docker`\n* `./start_infra` (in order to start Redis)\n\nUsing Boto/Boto3 endpoints:\n* Update the have the following environment variables (edit Run Confirguration in PyCharm)\n* `E2E_AWS_ACCESS_KEY` (from IAM account)\n* `E2E_AWS_SECRET_KEY` (from IAM account)\n* `SQS_QUEUE_URL` (from SQS queue information)\n\nRunning the main app:\n* `cd e2e/highlight_fastapi`\n* `poetry run uvicorn main:app`\n\nRunning Celery worker:\n* `cd e2e/highlight_fastapi`\n* `poetry run celery -A e2e.highlight_fastapi.work worker --loglevel=INFO`\n\n### Loguru\n\n* `cd e2e/highlight_loguru`\n* `poetry run python main.py`\n\n## Run tests\n\n* `poetry run pytest`\n\n## Lint\n\n* `poetry run black .`",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Session replay and error monitoring: stop guessing why bugs happen!",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://www.highlight.io/docs",
"Homepage": "https://www.highlight.io",
"Repository": "https://github.com/highlight/highlight"
},
"split_keywords": [
"web",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "283cc2dac422d4e9bdb17f8a1571ea6b0fe21c88877f364f567f560037f1a9bb",
"md5": "cd5689a3f079d9855acb9df1b54c0182",
"sha256": "9e79f8f561310ac6e07632653eccc15cff278468f4b76361ef11432a20f40efb"
},
"downloads": -1,
"filename": "highlight_io-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd5689a3f079d9855acb9df1b54c0182",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 16102,
"upload_time": "2024-04-16T19:52:18",
"upload_time_iso_8601": "2024-04-16T19:52:18.045211Z",
"url": "https://files.pythonhosted.org/packages/28/3c/c2dac422d4e9bdb17f8a1571ea6b0fe21c88877f364f567f560037f1a9bb/highlight_io-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c1154205ddaba8f52c3328f57be124646a440bf7a2adaeda7c68c1fc92e2d09",
"md5": "c874f8a73989d84d979111d84abd32df",
"sha256": "13da182d26b251d239bce005d7f30dcc7404a7a0cb2337a81e1bf9f3043f01c5"
},
"downloads": -1,
"filename": "highlight_io-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "c874f8a73989d84d979111d84abd32df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 10960,
"upload_time": "2024-04-16T19:52:20",
"upload_time_iso_8601": "2024-04-16T19:52:20.827865Z",
"url": "https://files.pythonhosted.org/packages/5c/11/54205ddaba8f52c3328f57be124646a440bf7a2adaeda7c68c1fc92e2d09/highlight_io-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 19:52:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "highlight",
"github_project": "highlight",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "highlight-io"
}
JSON
