ckanext-unfold


Nameckanext-unfold JSON
Version 1.0.4 PyPI version JSON
download
home_pageNone
SummaryProvides previews for multiple archive formats
upload_time2024-10-29 08:30:45
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseAGPL
keywords ckan
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![Tests](https://github.com/DataShades/ckanext-unfold/workflows/Tests/badge.svg?branch=master)](https://github.com/DataShades/ckanext-unfold/actions)

# ckanext-unfold

Enhance your CKAN experience with our extension that enables seamless previews of various archive formats, ensuring easy access and efficient data management.

## Supported Versions

CKAN >= 2.10

## Configuration

```ini
ckan.plugins = unfold
ckan.views.default_views = unfold_view
```

## What are the dependencies?

Working with different archive formats requires different tools:

### RAR, CBR

It depends on `unrar` command-line utility to do the actual decompression. Note that by default it expect it to be in `PATH`.
If unrar launching fails, you need to fix this.

Alternatively, `rarfile` can also use either [unar](https://theunarchiver.com/command-line) from [TheUnarchiver](https://theunarchiver.com/) or
[bsdtar](https://github.com/libarchive/libarchive/wiki/ManPageBsdtar1) from [libarchive](https://www.libarchive.org/) as
decompression backend. From those unar is preferred as bsdtar has very limited support for RAR archives.

It depends on [cryptography](https://pypi.org/project/cryptography/) or [PyCryptodome](https://pypi.org/project/pycryptodome/)
modules to process archives with password-protected headers.

### 7Z

We are using [`py7zr`](https://py7zr.readthedocs.io/) library.

The py7zr depends on several external libraries. You should install these libraries with py7zr.
There are `PyCryptodome`, `PyZstd`, `PyPPMd`, `bcj-cffi`, `texttable`, and `multivolumefile`.
These packages are automatically installed when installing with pip command.

For extra information, please visit the [official documentation](https://py7zr.readthedocs.io/en/latest/user_guide.html#dependencies),
especially the dependencies section.

### ZIP, ZIPX, JAR

We are using built-in library [`zipfile`](https://docs.python.org/3/library/zipfile.html). Please consider referring to the official documentation for more information.

### TAR, TAR.XZ, TAR.GZ, TAR.BZ2

We are using built-in library [`tarfile`](https://docs.python.org/3/library/tarfile.html). Please consider referring to the official documentation for more information.

### RPM

We are using [`rpmfile`](https://github.com/srossross/rpmfile) library.

If you want to use rpmfile with zstd compressed rpms, you'll need to install the [`zstandard`](https://pypi.org/project/zstandard/) module.

## License

[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ckanext-unfold",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "DataShades <datashades@linkdigital.com.au>",
    "keywords": "CKAN",
    "author": null,
    "author_email": "DataShades <datashades@linkdigital.com.au>, Oleksandr Cherniavskyi <mutantsan@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b9/b1/6c09941d6ef4e6d2339b89f2de6c70e968ba581b93e45218df01bb6d0959/ckanext_unfold-1.0.4.tar.gz",
    "platform": null,
    "description": "[![Tests](https://github.com/DataShades/ckanext-unfold/workflows/Tests/badge.svg?branch=master)](https://github.com/DataShades/ckanext-unfold/actions)\n\n# ckanext-unfold\n\nEnhance your CKAN experience with our extension that enables seamless previews of various archive formats, ensuring easy access and efficient data management.\n\n## Supported Versions\n\nCKAN >= 2.10\n\n## Configuration\n\n```ini\nckan.plugins = unfold\nckan.views.default_views = unfold_view\n```\n\n## What are the dependencies?\n\nWorking with different archive formats requires different tools:\n\n### RAR, CBR\n\nIt depends on `unrar` command-line utility to do the actual decompression. Note that by default it expect it to be in `PATH`.\nIf unrar launching fails, you need to fix this.\n\nAlternatively, `rarfile` can also use either [unar](https://theunarchiver.com/command-line) from [TheUnarchiver](https://theunarchiver.com/) or\n[bsdtar](https://github.com/libarchive/libarchive/wiki/ManPageBsdtar1) from [libarchive](https://www.libarchive.org/) as\ndecompression backend. From those unar is preferred as bsdtar has very limited support for RAR archives.\n\nIt depends on [cryptography](https://pypi.org/project/cryptography/) or [PyCryptodome](https://pypi.org/project/pycryptodome/)\nmodules to process archives with password-protected headers.\n\n### 7Z\n\nWe are using [`py7zr`](https://py7zr.readthedocs.io/) library.\n\nThe py7zr depends on several external libraries. You should install these libraries with py7zr.\nThere are `PyCryptodome`, `PyZstd`, `PyPPMd`, `bcj-cffi`, `texttable`, and `multivolumefile`.\nThese packages are automatically installed when installing with pip command.\n\nFor extra information, please visit the [official documentation](https://py7zr.readthedocs.io/en/latest/user_guide.html#dependencies),\nespecially the dependencies section.\n\n### ZIP, ZIPX, JAR\n\nWe are using built-in library [`zipfile`](https://docs.python.org/3/library/zipfile.html). Please consider referring to the official documentation for more information.\n\n### TAR, TAR.XZ, TAR.GZ, TAR.BZ2\n\nWe are using built-in library [`tarfile`](https://docs.python.org/3/library/tarfile.html). Please consider referring to the official documentation for more information.\n\n### RPM\n\nWe are using [`rpmfile`](https://github.com/srossross/rpmfile) library.\n\nIf you want to use rpmfile with zstd compressed rpms, you'll need to install the [`zstandard`](https://pypi.org/project/zstandard/) module.\n\n## License\n\n[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
    "bugtrack_url": null,
    "license": "AGPL",
    "summary": "Provides previews for multiple archive formats",
    "version": "1.0.4",
    "project_urls": {
        "Homepage": "https://github.com/DataShades/ckanext-unfold"
    },
    "split_keywords": [
        "ckan"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "54a13204fa6f8ecc2f6b32ff04eb0fa2ae57aa25301ca31ad004912c67848152",
                "md5": "8cfc164fb18f059b513da4263b9b4373",
                "sha256": "bafdb2b8d7753e7ddba09cce7d419486db4399df1fd02d5573631c7065a9e3a3"
            },
            "downloads": -1,
            "filename": "ckanext_unfold-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8cfc164fb18f059b513da4263b9b4373",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3055593,
            "upload_time": "2024-10-29T08:30:42",
            "upload_time_iso_8601": "2024-10-29T08:30:42.669267Z",
            "url": "https://files.pythonhosted.org/packages/54/a1/3204fa6f8ecc2f6b32ff04eb0fa2ae57aa25301ca31ad004912c67848152/ckanext_unfold-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b9b16c09941d6ef4e6d2339b89f2de6c70e968ba581b93e45218df01bb6d0959",
                "md5": "f59c85830f681777b7c893e34f39bdec",
                "sha256": "3082985762f213490ee1277cf36b2517ead4408734a568f05651c4944a26b7f7"
            },
            "downloads": -1,
            "filename": "ckanext_unfold-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f59c85830f681777b7c893e34f39bdec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1634842,
            "upload_time": "2024-10-29T08:30:45",
            "upload_time_iso_8601": "2024-10-29T08:30:45.611724Z",
            "url": "https://files.pythonhosted.org/packages/b9/b1/6c09941d6ef4e6d2339b89f2de6c70e968ba581b93e45218df01bb6d0959/ckanext_unfold-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-29 08:30:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DataShades",
    "github_project": "ckanext-unfold",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "ckanext-unfold"
}
        
Elapsed time: 0.97709s