| Name | ckanext-ckanpackager JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | |
| Summary | A CKAN extension that stores legacy download statistics from the deprecated service ckanpackager. |
| upload_time | 2023-07-18 08:53:50 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | GPL-3.0-or-later |
| keywords |
ckan
data
ckanpackager
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<!--notices-start-->
> **Warning**
> ## Version 3 of ckanext-ckanpackager removes support for ckanpackager.
>
> [ckanpackager](http://github.com/NaturalHistoryMuseum/ckanpackager) is being deprecated, and so v3 of this extension will no longer support connecting to it.
>
> **All** functionality is being removed _except for the database tables_, to allow other extensions continuing access to legacy data without having to maintain a ckanpackager instance.
>
> If you are still using ckanpackager and wish to use this extension with your instance, you will have to use v2 or earlier.
<!--notices-end-->
<!--header-start-->
<img src="https://data.nhm.ac.uk/images/nhm_logo.svg" align="left" width="150px" height="100px" hspace="40"/>
# ckanext-ckanpackager
[](https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager/actions/workflows/main.yml)
[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-ckanpackager)
[](https://github.com/ckan/ckan)
[](https://www.python.org/)
[](https://ckanext-ckanpackager.readthedocs.io)
_A CKAN extension that stores legacy download statistics from the deprecated service ckanpackager._
<!--header-end-->
# Overview
<!--overview-start-->
This extension uses a database table in the CKAN database to store stats about packaging events.
<!--overview-end-->
# Installation
<!--installation-start-->
Path variables used below:
- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`
- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`
## Installing from PyPI
```shell
pip install ckanext-ckanpackager
```
## Installing from source
1. Clone the repository into the `src` folder:
```shell
cd $INSTALL_FOLDER/src
git clone https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager.git
```
2. Activate the virtual env:
```shell
. $INSTALL_FOLDER/bin/activate
```
3. Install via pip:
```shell
pip install $INSTALL_FOLDER/src/ckanext-ckanpackager
```
### Installing in editable mode
Installing from a `pyproject.toml` in editable mode (i.e. `pip install -e`) requires `setuptools>=64`; however, CKAN 2.9 requires `setuptools==44.1.0`. See [our CKAN fork](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.
## Post-install setup
1. Add 'ckanpackager' to the list of plugins in your `$CONFIG_FILE`:
```ini
ckan.plugins = ... ckanpackager
```
2. Install `lessc` globally:
```shell
npm install -g "less@~4.1"
```
3. Initialise the database table:
```shell
ckan -c $CONFIG_FILE ckanpackager initdb
```
<!--installation-end-->
# Configuration
<!--configuration-start-->
All configuration options have been removed.
<!--configuration-end-->
# Usage
<!--usage-start-->
## Actions
### `packager_stats`
**REMOVED**
## Commands
### `initdb`
Initialises the ckanpackager database tables.
_This command is still valid, but if you don't already have these database tables, there may not be much point._
```bash
ckan -c $CONFIG_FILE ckanpackager initdb
```
## Templates
**REMOVED**
<!--usage-end-->
# Testing
<!--testing-start-->
There is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the `docker/` folder.
To run the tests against ckan 2.9.x on Python3:
1. Build the required images:
```shell
docker-compose build
```
2. Then run the tests.
The root of the repository is mounted into the ckan container as a volume by the Docker compose
configuration, so you should only need to rebuild the ckan image if you change the extension's
dependencies.
```shell
docker-compose run ckan
```
<!--testing-end-->
Raw data
{
"_id": null,
"home_page": "",
"name": "ckanext-ckanpackager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "CKAN,data,ckanpackager",
"author": "",
"author_email": "Natural History Museum <data@nhm.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/a8/46/a598fb52d367b3a0a75a24ee2471338be0220c6d17ae35b9531fb5ffc153/ckanext-ckanpackager-3.0.0.tar.gz",
"platform": null,
"description": "<!--notices-start-->\n> **Warning**\n> ## Version 3 of ckanext-ckanpackager removes support for ckanpackager.\n>\n> [ckanpackager](http://github.com/NaturalHistoryMuseum/ckanpackager) is being deprecated, and so v3 of this extension will no longer support connecting to it.\n>\n> **All** functionality is being removed _except for the database tables_, to allow other extensions continuing access to legacy data without having to maintain a ckanpackager instance.\n>\n> If you are still using ckanpackager and wish to use this extension with your instance, you will have to use v2 or earlier.\n\n<!--notices-end-->\n\n<!--header-start-->\n<img src=\"https://data.nhm.ac.uk/images/nhm_logo.svg\" align=\"left\" width=\"150px\" height=\"100px\" hspace=\"40\"/>\n\n# ckanext-ckanpackager\n\n[](https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager/actions/workflows/main.yml)\n[](https://coveralls.io/github/NaturalHistoryMuseum/ckanext-ckanpackager)\n[](https://github.com/ckan/ckan)\n[](https://www.python.org/)\n[](https://ckanext-ckanpackager.readthedocs.io)\n\n_A CKAN extension that stores legacy download statistics from the deprecated service ckanpackager._\n\n<!--header-end-->\n\n# Overview\n\n<!--overview-start-->\nThis extension uses a database table in the CKAN database to store stats about packaging events.\n\n<!--overview-end-->\n\n# Installation\n\n<!--installation-start-->\nPath variables used below:\n- `$INSTALL_FOLDER` (i.e. where CKAN is installed), e.g. `/usr/lib/ckan/default`\n- `$CONFIG_FILE`, e.g. `/etc/ckan/default/development.ini`\n\n## Installing from PyPI\n\n```shell\npip install ckanext-ckanpackager\n```\n\n## Installing from source\n\n1. Clone the repository into the `src` folder:\n ```shell\n cd $INSTALL_FOLDER/src\n git clone https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager.git\n ```\n\n2. Activate the virtual env:\n ```shell\n . $INSTALL_FOLDER/bin/activate\n ```\n\n3. Install via pip:\n ```shell\n pip install $INSTALL_FOLDER/src/ckanext-ckanpackager\n ```\n\n### Installing in editable mode\n\nInstalling from a `pyproject.toml` in editable mode (i.e. `pip install -e`) requires `setuptools>=64`; however, CKAN 2.9 requires `setuptools==44.1.0`. See [our CKAN fork](https://github.com/NaturalHistoryMuseum/ckan) for a version of v2.9 that uses an updated setuptools if this functionality is something you need.\n\n## Post-install setup\n\n1. Add 'ckanpackager' to the list of plugins in your `$CONFIG_FILE`:\n ```ini\n ckan.plugins = ... ckanpackager\n ```\n\n2. Install `lessc` globally:\n ```shell\n npm install -g \"less@~4.1\"\n ```\n\n3. Initialise the database table:\n ```shell\n ckan -c $CONFIG_FILE ckanpackager initdb\n ```\n\n<!--installation-end-->\n\n# Configuration\n\n<!--configuration-start-->\nAll configuration options have been removed.\n\n<!--configuration-end-->\n\n# Usage\n\n<!--usage-start-->\n## Actions\n\n### `packager_stats`\n**REMOVED**\n\n## Commands\n\n### `initdb`\nInitialises the ckanpackager database tables.\n\n_This command is still valid, but if you don't already have these database tables, there may not be much point._\n\n ```bash\n ckan -c $CONFIG_FILE ckanpackager initdb\n ```\n\n## Templates\n\n**REMOVED**\n\n<!--usage-end-->\n\n# Testing\n\n<!--testing-start-->\nThere is a Docker compose configuration available in this repository to make it easier to run tests. The ckan image uses the Dockerfile in the `docker/` folder.\n\nTo run the tests against ckan 2.9.x on Python3:\n\n1. Build the required images:\n ```shell\n docker-compose build\n ```\n\n2. Then run the tests.\n The root of the repository is mounted into the ckan container as a volume by the Docker compose\n configuration, so you should only need to rebuild the ckan image if you change the extension's\n dependencies.\n ```shell\n docker-compose run ckan\n ```\n\n<!--testing-end-->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A CKAN extension that stores legacy download statistics from the deprecated service ckanpackager.",
"version": "3.0.0",
"project_urls": {
"changelog": "https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager/blob/main/CHANGELOG.md",
"repository": "https://github.com/NaturalHistoryMuseum/ckanext-ckanpackager"
},
"split_keywords": [
"ckan",
"data",
"ckanpackager"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ddbcf20f592f0eb43df7cf3479bd73db066e90967e8907ece469a1d8851b096a",
"md5": "7701e404e964eec041f5214485af2111",
"sha256": "e137e61fc25369085decbe1ec80f436363a4f7c7948410d7b62f54453019818e"
},
"downloads": -1,
"filename": "ckanext_ckanpackager-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7701e404e964eec041f5214485af2111",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 18991,
"upload_time": "2023-07-18T08:53:49",
"upload_time_iso_8601": "2023-07-18T08:53:49.775169Z",
"url": "https://files.pythonhosted.org/packages/dd/bc/f20f592f0eb43df7cf3479bd73db066e90967e8907ece469a1d8851b096a/ckanext_ckanpackager-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a846a598fb52d367b3a0a75a24ee2471338be0220c6d17ae35b9531fb5ffc153",
"md5": "3ebd7c2ad794c029f455100cc11d4ae5",
"sha256": "9804e6e553bf9c183fa7402193656c6206152dcd7b88755af42129fc2b076b7e"
},
"downloads": -1,
"filename": "ckanext-ckanpackager-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3ebd7c2ad794c029f455100cc11d4ae5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17859,
"upload_time": "2023-07-18T08:53:50",
"upload_time_iso_8601": "2023-07-18T08:53:50.764065Z",
"url": "https://files.pythonhosted.org/packages/a8/46/a598fb52d367b3a0a75a24ee2471338be0220c6d17ae35b9531fb5ffc153/ckanext-ckanpackager-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-18 08:53:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NaturalHistoryMuseum",
"github_project": "ckanext-ckanpackager",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ckanext-ckanpackager"
}
