jxl-decode


Namejxl-decode JSON
Version 0.0.2 PyPI version JSON
download
home_page
SummaryA pure python JPEG XL decoder.
upload_time2023-06-08 19:34:13
maintainer
docs_urlNone
author
requires_python>=3.10
license
keywords jpeg xl jxl
VCS
bugtrack_url
requirements pytest build
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # jxl_decode

A pure python JPEG XL decoder. It is currently *very* incomplete.

## Installation

jxl_decode can be installed from [PyPI](https://pypi.org/project/jxl-decode/).

```sh
pip install jxl_decode
```

I am aiming to make this decoder as portable as possible. As such it will
ideally have minimal dependencies outside of the standard library. I may use a
dependency for PNG output, if I don't write one myself.

### Requirements

- Recent [Python 3](https://www.python.org/) (developed with 3.11, but may work
  with some older versions)

### Development Requirements

- [PyTest](https://docs.pytest.org/)

## Usage

We are a long way away from it, but this is how I intend the decoder to work
from the command line:

```sh
jxl_decode input_file.jxl [output_file.png]
```

## Roadmap/To Do

- [ ] Add tests (and possibly some more useful methods) to Bitstream class.
- [ ] Decide on internal representation of image data (NumPy array?)
- [x] Define external interfaces by decoding PPM image.
- [ ] PNG output of decoded images.
- [ ] Decode JPEG images.
- [ ] Start on JPEG XL support.

<!-- ## Contributing

State if you are open to contributions and what your requirements are for
accepting them.

For people who want to make changes to your project, it's helpful to have some
documentation on how to get started. Perhaps there is a script that they should
run or some environment variables that they need to set. Make these steps
explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help
to ensure high code quality and reduce the likelihood that the changes
inadvertently break something. Having instructions for running tests is
especially helpful if it requires external setup, such as starting a Selenium
server for testing in a browser. -->

<!-- ## Acknowledgements

Show your appreciation to those who have contributed to the project. -->

## Licence

This software is available under the [MIT Licence](LICENCE.md).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "jxl-decode",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "JPEG XL,jxl",
    "author": "",
    "author_email": "James Frost <git@frost.cx>",
    "download_url": "https://files.pythonhosted.org/packages/17/c6/73a489f356553ca855333659c0a4affe7b8379940527fc24ae121dce4733/jxl_decode-0.0.2.tar.gz",
    "platform": null,
    "description": "# jxl_decode\n\nA pure python JPEG XL decoder. It is currently *very* incomplete.\n\n## Installation\n\njxl_decode can be installed from [PyPI](https://pypi.org/project/jxl-decode/).\n\n```sh\npip install jxl_decode\n```\n\nI am aiming to make this decoder as portable as possible. As such it will\nideally have minimal dependencies outside of the standard library. I may use a\ndependency for PNG output, if I don't write one myself.\n\n### Requirements\n\n- Recent [Python 3](https://www.python.org/) (developed with 3.11, but may work\n  with some older versions)\n\n### Development Requirements\n\n- [PyTest](https://docs.pytest.org/)\n\n## Usage\n\nWe are a long way away from it, but this is how I intend the decoder to work\nfrom the command line:\n\n```sh\njxl_decode input_file.jxl [output_file.png]\n```\n\n## Roadmap/To Do\n\n- [ ] Add tests (and possibly some more useful methods) to Bitstream class.\n- [ ] Decide on internal representation of image data (NumPy array?)\n- [x] Define external interfaces by decoding PPM image.\n- [ ] PNG output of decoded images.\n- [ ] Decode JPEG images.\n- [ ] Start on JPEG XL support.\n\n<!-- ## Contributing\n\nState if you are open to contributions and what your requirements are for\naccepting them.\n\nFor people who want to make changes to your project, it's helpful to have some\ndocumentation on how to get started. Perhaps there is a script that they should\nrun or some environment variables that they need to set. Make these steps\nexplicit. These instructions could also be useful to your future self.\n\nYou can also document commands to lint the code or run tests. These steps help\nto ensure high code quality and reduce the likelihood that the changes\ninadvertently break something. Having instructions for running tests is\nespecially helpful if it requires external setup, such as starting a Selenium\nserver for testing in a browser. -->\n\n<!-- ## Acknowledgements\n\nShow your appreciation to those who have contributed to the project. -->\n\n## Licence\n\nThis software is available under the [MIT Licence](LICENCE.md).\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A pure python JPEG XL decoder.",
    "version": "0.0.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/Fraetor/jxl_decode/issues",
        "Homepage": "https://github.com/Fraetor/jxl_decode"
    },
    "split_keywords": [
        "jpeg xl",
        "jxl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b2a5266dd2fa5406b6c64370fd279d2b968a215360b97f9d89bdc0393b49b920",
                "md5": "56dc501eddb15eb7f9cf02a2a8eed918",
                "sha256": "74aa3205b600180d4106b3d4dde9ca5d96998905c272e650ef3789247f9f6a01"
            },
            "downloads": -1,
            "filename": "jxl_decode-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "56dc501eddb15eb7f9cf02a2a8eed918",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 8440,
            "upload_time": "2023-06-08T19:34:12",
            "upload_time_iso_8601": "2023-06-08T19:34:12.749617Z",
            "url": "https://files.pythonhosted.org/packages/b2/a5/266dd2fa5406b6c64370fd279d2b968a215360b97f9d89bdc0393b49b920/jxl_decode-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "17c673a489f356553ca855333659c0a4affe7b8379940527fc24ae121dce4733",
                "md5": "f1ccb7cc74f29ab70b17e9270838b852",
                "sha256": "68db3327c95575d3777549d33b3536496de10abbdb46ae00182afb87e01d7635"
            },
            "downloads": -1,
            "filename": "jxl_decode-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f1ccb7cc74f29ab70b17e9270838b852",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 7751,
            "upload_time": "2023-06-08T19:34:13",
            "upload_time_iso_8601": "2023-06-08T19:34:13.950873Z",
            "url": "https://files.pythonhosted.org/packages/17/c6/73a489f356553ca855333659c0a4affe7b8379940527fc24ae121dce4733/jxl_decode-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-08 19:34:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Fraetor",
    "github_project": "jxl_decode",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "build",
            "specs": []
        }
    ],
    "lcname": "jxl-decode"
}
        
Elapsed time: 0.22608s