[](https://github.com/GSA/ckanext-googleanalyticsbasic/actions)
[](https://badge.fury.io/py/ckanext-googleanalyticsbasic)
ckanext-googleanalyticsbasic
============================
Puts the Google Analytics asynchronous tracking code into your page headers for basic Google Analytics page tracking.
Installation
-------------
1. Install the extension as usual, e.g. (from an activated virtualenv)
::
$ pip install -e git+https://github.com/GSA/ckanext-googleanalyticsbasic#egg=ckanext-googleanalyticsbasic
2. Edit your development.ini (or similar) to provide space separated list of google ids
::
googleanalytics.ids = UA-1010101-1 UA-1010101-2
3. Edit again your configuration ini file to activate the plugin with:
::
ckan.plugins = googleanalyticsbasic
### Compatibility
This extension is compatible with these versions of CKAN.
CKAN version | Compatibility
------------- | -------------
<=2.8 | no
2.9 | yes
2.10 | yes
## Tests
All the tests live in the [/ckanext/geodatagov/tests](/ckanext/geodatagov/tests) folder.
## Using the Docker Dev Environment
### Build Environment
To start environment, run:
```docker-compose build```
```docker-compose up```
CKAN will start at localhost:5000
To shut down environment, run:
```docker-compose down```
To docker exec into the CKAN image, run:
```docker-compose exec app /bin/bash```
### Testing
They follow the guidelines for [testing CKAN
extensions](https://docs.ckan.org/en/2.10/extensions/testing-extensions.html#testing-extensions).
To run the extension tests, start the containers with `make up`, then:
$ make test
Lint the code.
$ make lint
### Matrix builds
The development environment drops as many dependencies as possible. It is
not meant to have feature parity with
[GSA/catalog.data.gov](https://github.com/GSA/catalog.data.gov/). Tests should
mock external dependencies where possible.
In order to support multiple versions of CKAN, or even upgrade to new versions
of CKAN, we support development and testing through the `CKAN_VERSION`
environment variable.
$ make CKAN_VERSION=2.10 test
Raw data
{
"_id": null,
"home_page": "https://github.com/GSA/ckanext-googleanalyticsbasic",
"name": "ckanext-googleanalyticsbasic",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Data.gov",
"author_email": "datagovhelp@gsa.gov",
"download_url": "https://files.pythonhosted.org/packages/0d/e4/03722795b971a70e61eda4ddbc14ee4de1dc2c37cb8a2e1c0aeff02d5c8d/ckanext-googleanalyticsbasic-0.2.1.tar.gz",
"platform": null,
"description": "[](https://github.com/GSA/ckanext-googleanalyticsbasic/actions)\n[](https://badge.fury.io/py/ckanext-googleanalyticsbasic)\n\n\nckanext-googleanalyticsbasic\n============================\n\nPuts the Google Analytics asynchronous tracking code into your page headers for basic Google Analytics page tracking.\n\nInstallation\n-------------\n1. Install the extension as usual, e.g. (from an activated virtualenv)\n\t\t::\n\t\t\n\t\t$ pip install -e git+https://github.com/GSA/ckanext-googleanalyticsbasic#egg=ckanext-googleanalyticsbasic\n\n2. Edit your development.ini (or similar) to provide space separated list of google ids\n\t\t::\n \t\n\t\tgoogleanalytics.ids = UA-1010101-1 UA-1010101-2\n\n3. Edit again your configuration ini file to activate the plugin with:\n\t\t::\n \t\n\t\tckan.plugins = googleanalyticsbasic\n\n### Compatibility\n\nThis extension is compatible with these versions of CKAN.\n\nCKAN version | Compatibility\n------------- | -------------\n<=2.8 | no\n2.9 | yes\n2.10 | yes\n\n## Tests\n\nAll the tests live in the [/ckanext/geodatagov/tests](/ckanext/geodatagov/tests) folder.\n\n## Using the Docker Dev Environment\n\n### Build Environment\n\nTo start environment, run:\n```docker-compose build```\n```docker-compose up```\n\nCKAN will start at localhost:5000\n\nTo shut down environment, run:\n\n```docker-compose down```\n\nTo docker exec into the CKAN image, run:\n\n```docker-compose exec app /bin/bash```\n\n### Testing\n\nThey follow the guidelines for [testing CKAN\nextensions](https://docs.ckan.org/en/2.10/extensions/testing-extensions.html#testing-extensions).\n\nTo run the extension tests, start the containers with `make up`, then:\n\n $ make test\n\nLint the code.\n\n $ make lint\n\n### Matrix builds\n\nThe development environment drops as many dependencies as possible. It is\nnot meant to have feature parity with\n[GSA/catalog.data.gov](https://github.com/GSA/catalog.data.gov/). Tests should\nmock external dependencies where possible.\n\nIn order to support multiple versions of CKAN, or even upgrade to new versions\nof CKAN, we support development and testing through the `CKAN_VERSION`\nenvironment variable.\n\n $ make CKAN_VERSION=2.10 test\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Basic extension to add google analytics tracking code in page header",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/GSA/ckanext-googleanalyticsbasic"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f35c0640629c7a64d61b45e071585b60e9972d3e69dc55d789dc129cd1da28b",
"md5": "7e5e7222026582af345d1bc7bd0f28bc",
"sha256": "62c1a364374646ef739bc92c76da245cd1a2b59068be0f05036ff8179414aebb"
},
"downloads": -1,
"filename": "ckanext_googleanalyticsbasic-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7e5e7222026582af345d1bc7bd0f28bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6199,
"upload_time": "2023-06-30T14:47:37",
"upload_time_iso_8601": "2023-06-30T14:47:37.265798Z",
"url": "https://files.pythonhosted.org/packages/8f/35/c0640629c7a64d61b45e071585b60e9972d3e69dc55d789dc129cd1da28b/ckanext_googleanalyticsbasic-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0de403722795b971a70e61eda4ddbc14ee4de1dc2c37cb8a2e1c0aeff02d5c8d",
"md5": "14e287202d2d5ebc7cdf0d3b70265747",
"sha256": "3dced0734a4b7cd46389d07025ee6c8684f82c7c43972f92477be7827bdf202a"
},
"downloads": -1,
"filename": "ckanext-googleanalyticsbasic-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "14e287202d2d5ebc7cdf0d3b70265747",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4612,
"upload_time": "2023-06-30T14:47:43",
"upload_time_iso_8601": "2023-06-30T14:47:43.556841Z",
"url": "https://files.pythonhosted.org/packages/0d/e4/03722795b971a70e61eda4ddbc14ee4de1dc2c37cb8a2e1c0aeff02d5c8d/ckanext-googleanalyticsbasic-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-30 14:47:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GSA",
"github_project": "ckanext-googleanalyticsbasic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ckanext-googleanalyticsbasic"
}
JSON
