Welcome to Zbarcam’s documentation!

Getting Started

Installation

Supported versions

  • Python 3.5+

Dependencies

Installation

Please see the garden docs for full installation instructions.

Install last zbarcam release from PyPI with:

pip install --upgrade zbarcam

Or develop branch directly from github with:

pip install https://github.com/kivy-garden/zbarcam/archive/develop.zip

You can also automatically install it using garden’s pypi server with:

python -m pip install zbarcam --extra-index-url https://kivy-garden.github.io/simple/

You can permanently add our garden server to your pip.conf so that you don’t have to specify it with --extra-index-url:

[global]
timeout = 60
index-url = https://kivy-garden.github.io/simple/

Examples

Basic Example

#:import ZBarCam kivy_garden.zbarcam.ZBarCam
#:import ZBarSymbol pyzbar.pyzbar.ZBarSymbol
BoxLayout:
    orientation: 'vertical'
    ZBarCam:
        id: zbarcam
        # optional, by default checks all types
        code_types: ZBarSymbol.QRCODE, ZBarSymbol.EAN13
    Label:
        size_hint: None, None
        size: self.texture_size[0], 50
        text: ', '.join([str(symbol.data) for symbol in zbarcam.symbols])

Zbarcam API

Zbarcam

kivy_garden.zbarcam

Contributing

How to release

This is documenting the release process.

Git flow & CHANGELOG.md

Make sure the CHANGELOG.md is up to date and follows the http://keepachangelog.com guidelines. Start the release with git flow:

git flow release start YYYY.MMDD

Now update the CHANGELOG.md [Unreleased] section to match the new release version. Also update the version string from the src/kivy_garden/zbarcam/version.py file. Then commit and finish release.

git commit -a -m "YYYY.MMDD"
git flow release finish

Push everything, make sure tags are also pushed:

git push
git push origin master:master
git push --tags

Publish to PyPI

Build it:

make release/build

This will build two packages, kivy_garden.zbarcam and the alias meta-package zbarcam. Also note we’re running twine check on both archives. You can also check archive content manually via:

tar -tvf dist/kivy_garden.zbarcam-*.tar.gz

Last step is to upload both packages:

make release/upload

Check Read the Docs

Make sure https://readthedocs.org/projects/zbarcam/ is up to date.

GitHub

Got to GitHub Release/Tags, click “Add release notes” for the tag just created. Add the tag name in the “Release title” field and the relevant CHANGELOG.md section in the “Describe this release” textarea field. Finally, attach the generated APK release file and click “Publish release”.

Indices and tables