Skip to content

Latest commit

 

History

History
233 lines (159 loc) · 7.23 KB

INSTALL.md

File metadata and controls

233 lines (159 loc) · 7.23 KB
Raw

pyscard: smartcard library for python

https://pyscard.sourceforge.io/

Copyright 2001-2012 Gemalto

Authors:

This file is part of pyscard.

pyscard is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

pyscard is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with pyscard; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

pyscard is a python module adding smart cards support to python.

It consists of the smartcard.scard module, an extension module wrapping Windows smart card base components (also known as PCSC) on Windows, and PCSC lite on GNU/Linux and macOS, and of the smartcard module, a python framework with objects wrapping PCSC API.

Documentation

All documentation is provided in the smartcard/doc directory of the source distribution. Examples are provided in the smartcard/Examples directory of the source distribution. The binary distribution does not include any documentation, tests scripts or examples.

Installation

The pyscard library is packaged using the standard distutils python module.

Installation on windows

Installing on windows from the binary distribution

  1. download the binary msi installer or self-executable installer
  2. execute the installer

The binary msi installer and self-executable installer are packaged for a specific version of python, and have name similar to pyscard-1.7.<xx>.win32-py2.7.msi and pyscard-1.7.<xx>.win32-py2.7.exe.

Installing on windows from the source distribution

  1. you will need swig from (http://www.swig.org), and a C compiler.

Visual Studio 2008 is required for building the C language wrapper. You can download Microsoft Visual C++ Compiler for Python 2.7 (http://aka.ms/vcpython27).

  1. download the source distribution

The source distribution is available as pyscard-1.7.<xx>.zip for windows, and pyscard-1.7.<xx>.tar.gz for GNU/Linux.

  1. unzip the source distribution, open a console and type the following:
setup.py build_ext install

This will build pyscard and install it in the site-packages directory of your python distribution, e.g. c:\python25\Lib\site-packages\smartcard.

This install procedure does not install the documentation, examples or test files.

Installation on GNU/Linux

Installing on GNU/Linux from the binary distribution

  1. download the binary distribution

The binary distribution is either an archive file or a rpm file, with names similar to pyscard-1.7.<xx>-1.i386.rpm for the rpm distribution, or pyscard-1.7.<xx>.linux-i686.tar.gz for the archive distribution.

  1. untar the binary distribution

With root privilege from a terminal, extract the archive from /, or install the rpm.

Installing on GNU/Linux from the source distribution

  1. you will need gcc, swig (http://www.swig.org), and pcsc-lite (https://pcsclite.apdu.fr/)

  2. download the source distribution

The source distribution is available as pyscard-1.7.<xx>.zip or pyscard-1.7.<xx>.tar.gz.

  1. untar the source distribution

  2. from a terminal with root privileges, type the following:

/usr/bin/python setup.py build_ext install

This will build pyscard and install it in the site-packages directory of your python distribution, e.g. /usr/lib/python2.7/site-packages/smartcard.

Installation on macOS

Installing on macOS from the binary distribution

  1. download the binary distribution

The binary distribution is an archive file, with a name similar to pyscard-1.7.<xx>-py-2.7-macosx10.7.mpkg.

  1. Open the package and proceed with installation.

Installing on macOS from the source distribution

  1. you will need swig (http://www.swig.org) and Xcode (https://developer.apple.com/xcode/); pcsc-lite is available out of the box on macOS.

  2. download the source distribution

The source distribution is available as pyscard-1.7.<xx>.zip or pyscard-1.7.<xx>.tar.gz.

  1. untar or unzip the source distribution

  2. from a terminal, type the following:

sudo python setup.py build_ext install

This will build pyscard and install it in the site-packages directory of your python distribution, e.g. /Library/Python/2.7/lib/site-packages/smartcard.

Developer documentation, unit tests and examples

The developer documentation is in the smartcard/doc directory of the source distribution.

Examples are located in the smartcard/Examples directory, and the pyunit unit tests in the smartcard/test directory.

Build instructions for packagers

Building a binary distribution for Windows

To build a binary distribution from the source distribution, you will need a C compiler and swig (same requirements as for installing from the source distribution).

In the root directory of the source distribution, execute the following command in a console:

setup.py build_ext bdist_msi
setup.py build_ext bdist_wininst

This will build the msi installer and self-executable installer in the dist directory, with names similar to pyscard-1.7.<xx>.win32-py2.7.msi and pyscard-1.7.<xx>.win32-py2.7.exe.

Building a binary distribution for GNU/Linux

To build a binary distribution from the source distribution, you will need gcc, swig and pcsc-lite (same requirements as for installing from the source distribution).

In the root directory of the source distribution, execute the following command in a terminal:

/usr/bin/python setup.py build_ext bdist

This will build a package similar to pyscard-1.7.<xx>.linux-i686.tar.gz containing a tree

Building a binary distribution for macOS

To build a binary distribution from the source distribution, you will need swig and Xcode (same requirements as for installing from the source distribution) and bdist_mpkg 0.5.0+ (http://pypi.python.org/pypi/bdist_mpkg/).

Install bdist_mpkg by executing the bdist_mpkg setup.py script with build and install as arguments, i.e. from the root directory of the bdist_mpkg source distribution enter: python setup.py build install.

From the root directory of the pyscard source distribution, i.e. in the src directory, execute the following commands in a terminal:

python setup.py build_ext
bdist_mpkg setup.py

This will build package pyscard-1.7.<xx>-py-2.7-macosx10.7.mpkg in the dist directory.