Developers¶
If you are a developer and use pyunraw in your project, you will find here useful information.
Getting the code¶
pyunraw’s source code is versioned with bazaar, and the main development focus (sometimes referred to as trunk), is hosted on Launchpad.
To get a working copy of the latest revision of the development branch, just issue the following command in a terminal:
bzr branch lp:pyunraw
Dependencies¶
To build pyunraw
- gcc
- python-all-dev (≥ 3.2)
- liblcms2-dev (>= 2.2-1)
- libjpeg-dev (>= 8c)
To use pyunraw
- python 3
- liblcms2
- libjpeg
Building and installing¶
Open a terminal into the folder and enter:
$ python3 setup.py build
Then you will find into /build/lib… a file named _pyunraw.cpython-xym… where xy is your version of python.
In your python3/dist-packages folder create a subfolder pyunraw and copy into this folder the files __init__.py, pyunraw.py and the file _pyunraw.cpython-xym…
Now, run your python3 interactive interpreter and import pyunraw to see if there’s no error.
Install from PyPI¶
pyunraw is available from PyPI
Use, with admin rights if necessary, the command:
$ pip3 install pyunraw
Documentation¶
The present documentation is generated using
Sphinx from reStructuredText sources found in the
doc/ directory. Invoke make html
to (re)build the HTML documentation.
The index of the documentation will then be found under doc/_build/html/index.html.
Contributing¶
pyunraw is Free Software, meaning that you are encouraged to use it, modify it to suit your needs, contribute back improvements, and redistribute it.
If you want to fork it on GitHub, you will find usefull information on how to import the branch from Launchpad to GitHub here.
Bugs are tracked on Launchpad. When reporting a bug, don’t forget to include the following information in the report:
- version of pyunraw
- a minimal script that reliably reproduces the issue
- a sample image file with which the bug can reliably be reproduced (or a link to)