[![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": "https://github.com/ckan/ckanext-fdt-sqlalchemy",
"name": "ckanext-fdt-sqlalchemy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "CKAN SQL debug",
"author": "Sergey Motornyuk",
"author_email": "sergey.motornyuk@linkdigital.com.au",
"download_url": "https://files.pythonhosted.org/packages/0b/b8/239c1994e5efb63b0a5bb0c1e2d0f08d0a53439b0aa45dd4a24904b6801e/ckanext-fdt-sqlalchemy-0.0.2.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",
"project_urls": {
"Homepage": "https://github.com/ckan/ckanext-fdt-sqlalchemy"
},
"split_keywords": [
"ckan",
"sql",
"debug"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1a1a478dbbf059213cbde0fb7c973a11f0b7c2c37240bea2b41896ae045b957",
"md5": "1c422f816b08680f205b50aacae17f4d",
"sha256": "3be6a062809da383f265dc05184baa89dbea8d983557a720678d524823b89910"
},
"downloads": -1,
"filename": "ckanext_fdt_sqlalchemy-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c422f816b08680f205b50aacae17f4d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17686,
"upload_time": "2023-06-27T11:27:08",
"upload_time_iso_8601": "2023-06-27T11:27:08.546352Z",
"url": "https://files.pythonhosted.org/packages/a1/a1/a478dbbf059213cbde0fb7c973a11f0b7c2c37240bea2b41896ae045b957/ckanext_fdt_sqlalchemy-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bb8239c1994e5efb63b0a5bb0c1e2d0f08d0a53439b0aa45dd4a24904b6801e",
"md5": "214277e3be006fe8b095eb69d051a8f2",
"sha256": "de6baa06bf73d3a95771643c12070cbf2c06e778a2c79955d873c67e6b45ffef"
},
"downloads": -1,
"filename": "ckanext-fdt-sqlalchemy-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "214277e3be006fe8b095eb69d051a8f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18210,
"upload_time": "2023-06-27T11:27:10",
"upload_time_iso_8601": "2023-06-27T11:27:10.321297Z",
"url": "https://files.pythonhosted.org/packages/0b/b8/239c1994e5efb63b0a5bb0c1e2d0f08d0a53439b0aa45dd4a24904b6801e/ckanext-fdt-sqlalchemy-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 11:27:10",
"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"
}