ckanext-datapackage-creator


Nameckanext-datapackage-creator JSON
Version 0.0.60 PyPI version JSON
download
home_page
SummaryData Package Creator.
upload_time2023-03-20 12:14:13
maintainer
docs_urlNone
authorTransparência Minas Gerais
requires_python
licenseAGPL
keywords ckan
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CKNEXT Data Package Creator

CKAN extension to use the fritioncless library


## Table of Contents

  * [Publish or Update Package to Pypi](#publish-or-update-package-to-pypi)
  * [Installation](#installation)
  * [Configuration](#configuration)

## Publish or Update Package to Pypi

- Check the last version published on [Pypi](https://pypi.org/project/ckanext-datapackage-creator/).
- Update `CHANGELOG.md` file with a short review of what had been done.
- Update `setup.py` file with the new version number.
- Commit all the above changes with the new version number (one above that publish on Pypi). Example: `git commit -am 'v0.1.1'`.
- Push the created commit to the online repository: Example: `git push origin master`.
- Create a new tag with the new version number (same as used to commit last changes). Example: `git tag v0.1.1 HEAD`.
- Push the new created tag to the online repository: Example: `git push origin v0.1.1`.
- Publish on Pypi with `make update-package`.


## Instalation

```
pip install ckanext-datapackage-creator
```


## Configuration

Once installed, add the `datapackage_creator` plugin to the `ckan.plugins` configuration option in your INI file.

```
ckan.plugins = ... datapackage_creator
```

# Datapackage Creator Configuration

Opening the file with vi editor
````
sudo vi /etc/ckan/default/datapackage_creator.json
````

The plugin allows you to configure which fields of the resource and package are mandatory and/or 'readonly', for this you just need to add a configuration in your INI file.


```
datapackage_creator = /path/to/datapackage_creator.json
```

We suggest that the file path would be `/etc/ckan/default/datapackage_creator.json` or in the same folder as `ckan.ini` file.

Configuration example file:

```
{
    "package": {
        "required": [],
        "readonly": []
    },
    "resource": {
        "required": [],
        "readonly": []
    },
    "token": ""
}
```

## Mandatory possible package fields:

- description
- source
- version
- license
- frequency
- tags
- author
- author_email

## Possible read-only package fields:

Nothing

## Mandatory possible resource fields:

- title
- description
- format
- type
- encoding
- field.name (Column field)
- field.title (Column field)
- field.description (Column field)
- field.format (Column field)


## Possible read-only package fields:

- format
- type
- encoding


## Token

It is necessary to configure an administrator token so that the plugin can query private data

# Entity Diagram

To generate the entity diagram it is necessary to install the library: graphviz.

On ubuntu: sudo apt-get install graphviz

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ckanext-datapackage-creator",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "CKAN",
    "author": "Transpar\u00eancia Minas Gerais",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/ac/ea/0af8475ed1d59274eaa0526559b1436b029bf6173244be7b0854d1610d7e/ckanext-datapackage-creator-0.0.60.tar.gz",
    "platform": null,
    "description": "# CKNEXT Data Package Creator\n\nCKAN extension to use the fritioncless library\n\n\n## Table of Contents\n\n  * [Publish or Update Package to Pypi](#publish-or-update-package-to-pypi)\n  * [Installation](#installation)\n  * [Configuration](#configuration)\n\n## Publish or Update Package to Pypi\n\n- Check the last version published on [Pypi](https://pypi.org/project/ckanext-datapackage-creator/).\n- Update `CHANGELOG.md` file with a short review of what had been done.\n- Update `setup.py` file with the new version number.\n- Commit all the above changes with the new version number (one above that publish on Pypi). Example: `git commit -am 'v0.1.1'`.\n- Push the created commit to the online repository: Example: `git push origin master`.\n- Create a new tag with the new version number (same as used to commit last changes). Example: `git tag v0.1.1 HEAD`.\n- Push the new created tag to the online repository: Example: `git push origin v0.1.1`.\n- Publish on Pypi with `make update-package`.\n\n\n## Instalation\n\n```\npip install ckanext-datapackage-creator\n```\n\n\n## Configuration\n\nOnce installed, add the `datapackage_creator` plugin to the `ckan.plugins` configuration option in your INI file.\n\n```\nckan.plugins = ... datapackage_creator\n```\n\n# Datapackage Creator Configuration\n\nOpening the file with vi editor\n````\nsudo vi /etc/ckan/default/datapackage_creator.json\n````\n\nThe plugin allows you to configure which fields of the resource and package are mandatory and/or 'readonly', for this you just need to add a configuration in your INI file.\n\n\n```\ndatapackage_creator = /path/to/datapackage_creator.json\n```\n\nWe suggest that the file path would be `/etc/ckan/default/datapackage_creator.json` or in the same folder as `ckan.ini` file.\n\nConfiguration example file:\n\n```\n{\n    \"package\": {\n        \"required\": [],\n        \"readonly\": []\n    },\n    \"resource\": {\n        \"required\": [],\n        \"readonly\": []\n    },\n    \"token\": \"\"\n}\n```\n\n## Mandatory possible package fields:\n\n- description\n- source\n- version\n- license\n- frequency\n- tags\n- author\n- author_email\n\n## Possible read-only package fields:\n\nNothing\n\n## Mandatory possible resource fields:\n\n- title\n- description\n- format\n- type\n- encoding\n- field.name (Column field)\n- field.title (Column field)\n- field.description (Column field)\n- field.format (Column field)\n\n\n## Possible read-only package fields:\n\n- format\n- type\n- encoding\n\n\n## Token\n\nIt is necessary to configure an administrator token so that the plugin can query private data\n\n# Entity Diagram\n\nTo generate the entity diagram it is necessary to install the library: graphviz.\n\nOn ubuntu: sudo apt-get install graphviz\n",
    "bugtrack_url": null,
    "license": "AGPL",
    "summary": "Data Package Creator.",
    "version": "0.0.60",
    "split_keywords": [
        "ckan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3ef588e9c0f41c325a0b32a7d1df980764cea44c69c65b210177e46e22dc1ac",
                "md5": "cfc895fa4cde49a9d08d9d5fa58e57eb",
                "sha256": "5251609306fd955fdc53fc51e950e5c01a9d820f5d7583c1be550b6956914016"
            },
            "downloads": -1,
            "filename": "ckanext_datapackage_creator-0.0.60-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfc895fa4cde49a9d08d9d5fa58e57eb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3736652,
            "upload_time": "2023-03-20T12:14:07",
            "upload_time_iso_8601": "2023-03-20T12:14:07.984237Z",
            "url": "https://files.pythonhosted.org/packages/f3/ef/588e9c0f41c325a0b32a7d1df980764cea44c69c65b210177e46e22dc1ac/ckanext_datapackage_creator-0.0.60-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "acea0af8475ed1d59274eaa0526559b1436b029bf6173244be7b0854d1610d7e",
                "md5": "5142a5a13fa038acc7239c7439878dcc",
                "sha256": "ddddf9dfdc3b224ffed6a687c8bd89b8dccc17da93c0653870dd9b157e8487bd"
            },
            "downloads": -1,
            "filename": "ckanext-datapackage-creator-0.0.60.tar.gz",
            "has_sig": false,
            "md5_digest": "5142a5a13fa038acc7239c7439878dcc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3682298,
            "upload_time": "2023-03-20T12:14:13",
            "upload_time_iso_8601": "2023-03-20T12:14:13.714715Z",
            "url": "https://files.pythonhosted.org/packages/ac/ea/0af8475ed1d59274eaa0526559b1436b029bf6173244be7b0854d1610d7e/ckanext-datapackage-creator-0.0.60.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-20 12:14:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "ckanext-datapackage-creator"
}
        
Elapsed time: 0.04573s