Skip to content

Commit

Permalink
Correct README
Browse files Browse the repository at this point in the history
  • Loading branch information
benallard committed Nov 28, 2012
1 parent 7dcd542 commit b17da9e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 16 deletions.
36 changes: 22 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,42 @@
(a.k.a ``JavaCard`` under PyPi)
---------------------------------

This is a pure python version of the javacard operating system as found on
javacard smartcards.
This is a pure python version of the javacard operating system as
found on javacard smartcards.

It does not provides much on his own beside the functionnalities of the
Operating System, as such, it is often used in combinason with others projects
like CAPRunner_ (linked with CAP files) or WebSCard_ (through CAPRunner or
python versions of Applets)
Operating System, as such, it is often used in combination with others
projects like CAPRunner_ (linked via .CAP files) or WebSCard_ (through
CAPRunner or python versions of Applets).

Documentation on this project is better found as original JavaCard
documentation (ask Google). The goal is to replication the exact same
functionnalities. If your experience is other, please fill in a `bug report`_.
Same for missing functionnalities.
functionnalities. If your experience is other, please fill in a `bug
report`_. Please do the same for missing functionnalities. As for now,
I only implemented the functionnalities I was needing during my
various tests.

To **use it**, when writing your Applet, just replace the following Java
construction::
To **use it**, when writing your Applet, just replace the following
Java construction::

import javacard.framework.Applet;

with::

from pythoncard.framework import Applet

As, so far I know, the javacard version are backward compatible, the goal is to
provide a classic 3.0.1 version, while maintaining compatiblity with earlier
version like 2.1.2.
As, so far I know, the javacard version are backward compatible, the
goal is to provide a classic 3.0.1 version, while maintaining
compatiblity with earlier version like 2.1.2.

PythonCard is dependant on pyDes_ and pyCrypto_ for crptographic operations. The
rest of the functionnalities will however work without those packages installed.
PythonCard is dependant on pyDes_ and pyCrypto_ for cryptographic
operations. The rest of the functionnalities will however work without
those packages installed.

To install it, either put the necessary directories in your
``PYTHONPATH``, or install it via PyPi::

$ pip install JavaCard

.. _CAPRunner: https://bitbucket.org/benallard/caprunner
.. _WebSCard: https://bitbucket.org/benallard/webscard
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
'License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)',
'Programming Language :: Python :: 2',
'Topic :: Software Development :: Libraries :: Python Modules',
],
keywords='java smartcard javacard sun',
],
keywords='java smartcard javacard sun',
)

0 comments on commit b17da9e

Please sign in to comment.