Skip to content

Latest commit

 

History

History
125 lines (89 loc) · 2.87 KB

DEVELOPING.md

File metadata and controls

125 lines (89 loc) · 2.87 KB
Raw

Development

mkvirtualenv pyzbar
pip install -U pip
pip install -r requirements.pip

nosetests
python -m pyzbar.scripts.read_zbar pyzbar/tests/code128.png

Testing python versions

Make a virtual env and install tox

mkvirtualenv tox
pip install tox

If you use non-standard locations for your Python builds, make the interpreters available on the PATH before running tox.

PATH=~/local/python-2.7.14/bin:~/local/python-3.4.8/bin:~/local/python-3.5.5/bin:~/local/python-3.6.5/bin:$PATH
tox

Windows

Save the 32-bit and 64-bit zbar.dll files, and their dependencies, to libzbar-32.dll and libzbar-64.dll respectively, in the pyzbar directory. The load_zbar function in wrapper.py looks for the appropriate DLLs. The appropriate DLLs are packaged up into the wheel build and is installed alongside the package source. This strategy allows the same method to be used when pyzbar is run from source, as an installed package and when included in a frozen binary.

Releasing

  1. Install tools.
pip install wheel

  1. Build Create source and wheel builds. The win32 and win_amd64 wheels will contain the appropriate zbar.dll and its dependencies.

    rm -rf build dist MANIFEST.in pyzbar.egg-info
cp MANIFEST.in.all MANIFEST.in
./setup.py bdist_wheel

cat MANIFEST.in.all MANIFEST.in.win32 > MANIFEST.in
./setup.py bdist_wheel --plat-name=win32

# Remove these dirs to prevent win32 DLLs from being included in win64 build
rm -rf build pyzbar.egg-info
cat MANIFEST.in.all MANIFEST.in.win64 > MANIFEST.in
./setup.py bdist_wheel --plat-name=win_amd64

rm -rf build MANIFEST.in pyzbar.egg-info

  2. Release to TestPyPI (see https://packaging.python.org/guides/using-testpypi/)

    mkvirtualenv pypi
pip install twine
twine upload -r pypitest dist/*

  3. Test the release to TestPyPI

    set PATH=%PATH%;c:\python35\;c:\python35\scripts
\Python35\Scripts\mkvirtualenv.bat --python=c:\python27\python.exe test1
    • Install dependencies that are not on testpypi.python.org. If you are on Python 2.x, these are mandatory
    pip install enum34 pathlib
    • Pillow for tests and command-line programs. We can't use the pip install pyzbar[scripts] form here because Pillow will not be on testpypi.python.org
    pip install Pillow
    • Install the package itself
    pip install --index https://testpypi.python.org/simple pyzbar
    • Test
    read_zbar --help
read_zbar <path-to-image-with-barcode.png>

  4. If all is well, release to PyPI

    twine upload dist/*

    pip install pyzbar[scripts]