| Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame^] | 1 | .. pysim documentation master file |
| 2 | |
| 3 | Welcome to Osmocom pySim |
| 4 | ======================== |
| 5 | |
| 6 | Introduction |
| 7 | ------------ |
| 8 | |
| 9 | pySim is a python implementation of various software that helps you with |
| 10 | managing subscriber identity cards for cellular networks, so-called SIM |
| 11 | cards. |
| 12 | |
| 13 | Many Osmocom (Open Source Mobile Communications) projects relate to operating |
| 14 | private / custom cellular networks, and provisioning SIM cards for said networks |
| 15 | is in many cases a requirement to operate such networks. |
| 16 | |
| 17 | To make use of most of pySim's features, you will need a `programmable` SIM card, |
| 18 | i.e. a card where you are the owner/operator and have sufficient credentials (such |
| 19 | as the `ADM PIN`) in order to write to many if not most of the files on the card. |
| 20 | |
| 21 | Such cards are, for example, available from sysmocom, a major contributor to pySim. |
| 22 | See https://www.sysmocom.de/products/lab/sysmousim/ for more details. |
| 23 | |
| 24 | pySim supports classic GSM SIM cards as well as ETSI UICC with 3GPP USIM and ISIM |
| 25 | applications. It is easily extensible, so support for additional files, card |
| 26 | applications, etc. can be added easily by any python developer. We do encourage you |
| 27 | to submit your contributions to help this collaborative development project. |
| 28 | |
| 29 | pySim consists of several parts: |
| 30 | |
| 31 | * a python :ref:`library<pySim library>` containing plenty of objects and methods that can be used for |
| 32 | writing custom programs interfacing with SIM cards. |
| 33 | * the [new] :ref:`interactive pySim-shell command line program<pySim-shell>` |
| 34 | * the [legacy] :ref:`pySim-prog and pySim-read tools<Legacy tools>` |
| 35 | |
| 36 | .. toctree:: |
| 37 | :maxdepth: 2 |
| 38 | :caption: Contents: |
| 39 | |
| 40 | shell |
| 41 | legacy |
| 42 | library |
| 43 | |
| 44 | |
| 45 | Indices and tables |
| 46 | ================== |
| 47 | |
| 48 | * :ref:`genindex` |
| 49 | * :ref:`modindex` |
| 50 | * :ref:`search` |