[![Tests](https://github.com/ckan/ckanext-fdt-sqlalchemy/workflows/Tests/badge.svg?branch=main)](https://github.com/ckan/ckanext-fdt-sqlalchemy/actions)
# ckanext-fdt-sqlalchemy
Enable Flask-DebugToolbar's SQLAlchemy pane.
![SQLAlchemy panel](/screenshots/1.png?raw=true)
## Requirements
Compatibility with core CKAN versions:
| CKAN version | Compatible? |
|--------------|-------------|
| 2.9 | yes |
| 2.10 | yes |
This plugin requires `flask-sqlalchemy~=2.5.0`.
The latest version(v3.0) of `flask-sqlalchemy` only partially supported. While
it shows all the queries, `SELECT` and `EXPLAIN` links for individual queries
do not work.
## Installation
To install ckanext-fdt-sqlalchemy:
1. Install the plugin and `flask-sqlalchemy~=2.5.0`:
```sh
pip install 'ckanext-fdt-sqlalchemy[deps]'
```
1. Add `fdt_sqlalchemy` to the `ckan.plugins` setting in your CKAN
config file.
## Developer installation
To install ckanext-fdt-sqlalchemy for development, activate your CKAN virtualenv and
do:
```sh
git clone https://github.com/ckan/ckanext-fdt-sqlalchemy.git
cd ckanext-fdt-sqlalchemy
python setup.py develop
```
## Tests
To run the tests, do:
```sh
pytest --ckan-ini=test.ini
```
## License
[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
Raw data
{
"_id": null,
"home_page": null,
"name": "ckanext-fdt-sqlalchemy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "DataShades <datashades@linkdigital.com.au>",
"keywords": "CKAN SQL debug",
"author": null,
"author_email": "DataShades <datashades@linkdigital.com.au>, Sergey Motornyuk <sergey.motornyuk@linkdigital.com.au>",
"download_url": "https://files.pythonhosted.org/packages/b6/99/62c17205823260e4f44bacb3cd760f725cd4a39ce1066d73cf0ae63785d3/ckanext_fdt_sqlalchemy-0.0.2.post1.tar.gz",
"platform": null,
"description": "[![Tests](https://github.com/ckan/ckanext-fdt-sqlalchemy/workflows/Tests/badge.svg?branch=main)](https://github.com/ckan/ckanext-fdt-sqlalchemy/actions)\n\n# ckanext-fdt-sqlalchemy\n\nEnable Flask-DebugToolbar's SQLAlchemy pane.\n\n![SQLAlchemy panel](/screenshots/1.png?raw=true)\n\n## Requirements\n\nCompatibility with core CKAN versions:\n\n| CKAN version | Compatible? |\n|--------------|-------------|\n| 2.9 | yes |\n| 2.10 | yes |\n\n\nThis plugin requires `flask-sqlalchemy~=2.5.0`.\n\nThe latest version(v3.0) of `flask-sqlalchemy` only partially supported. While\nit shows all the queries, `SELECT` and `EXPLAIN` links for individual queries\ndo not work.\n\n## Installation\n\nTo install ckanext-fdt-sqlalchemy:\n\n1. Install the plugin and `flask-sqlalchemy~=2.5.0`:\n ```sh\n pip install 'ckanext-fdt-sqlalchemy[deps]'\n ```\n\n1. Add `fdt_sqlalchemy` to the `ckan.plugins` setting in your CKAN\n config file.\n\n\n## Developer installation\n\nTo install ckanext-fdt-sqlalchemy for development, activate your CKAN virtualenv and\ndo:\n```sh\ngit clone https://github.com/ckan/ckanext-fdt-sqlalchemy.git\ncd ckanext-fdt-sqlalchemy\npython setup.py develop\n```\n\n## Tests\n\nTo run the tests, do:\n```sh\npytest --ckan-ini=test.ini\n```\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Enable SQLAlchemy pane of Flask-DebugToolbar",
"version": "0.0.2.post1",
"project_urls": {
"Homepage": "https://github.com/ckan/ckanext-fdt-sqlalchemy"
},
"split_keywords": [
"ckan",
"sql",
"debug"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40415461db7136b76c35012c2636aa2d15ba750401980d0f64c4f7f256e49849",
"md5": "2826856fae9a9c4e150be82e4096e030",
"sha256": "72685132ad62a6bba9baf525d48ad7663b26bb567bdc1e6649ec19eef3d936da"
},
"downloads": -1,
"filename": "ckanext_fdt_sqlalchemy-0.0.2.post1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2826856fae9a9c4e150be82e4096e030",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17386,
"upload_time": "2024-10-17T14:42:00",
"upload_time_iso_8601": "2024-10-17T14:42:00.433217Z",
"url": "https://files.pythonhosted.org/packages/40/41/5461db7136b76c35012c2636aa2d15ba750401980d0f64c4f7f256e49849/ckanext_fdt_sqlalchemy-0.0.2.post1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b69962c17205823260e4f44bacb3cd760f725cd4a39ce1066d73cf0ae63785d3",
"md5": "fde10f8047f78353918371457353e042",
"sha256": "6f0f78524f3ded64ca1a26b74b829d85806ae8fd8ea1df1fe2eadb6abf2bcd22"
},
"downloads": -1,
"filename": "ckanext_fdt_sqlalchemy-0.0.2.post1.tar.gz",
"has_sig": false,
"md5_digest": "fde10f8047f78353918371457353e042",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18383,
"upload_time": "2024-10-17T14:42:02",
"upload_time_iso_8601": "2024-10-17T14:42:02.172408Z",
"url": "https://files.pythonhosted.org/packages/b6/99/62c17205823260e4f44bacb3cd760f725cd4a39ce1066d73cf0ae63785d3/ckanext_fdt_sqlalchemy-0.0.2.post1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 14:42:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ckan",
"github_project": "ckanext-fdt-sqlalchemy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "ckanext-fdt-sqlalchemy"
}