commit | 12af793d4be9171c09ed7a31f5a8693e29210bb3 | [log] [tgz] |
---|---|---|
author | Harald Welte <laforge@osmocom.org> | Tue Feb 15 16:39:08 2022 +0100 |
committer | Harald Welte <laforge@osmocom.org> | Tue Feb 15 16:40:45 2022 +0100 |
tree | 07906017472410c12c70749ac39cbc5df988c2a9 | |
parent | d01bd3632c4747b8c624cc0eba7da4959357c285 [diff] |
doc: Improve documentation in various places * don't duplicate information between .rst files and docstrings * if there's more than a trivial single-line documentation, put it as docstring into the python source and use ".. argparse" to pul it into the manual * add documentation for some commands for which it was missing * show one level deeper in the navigation table, listing the commands Change-Id: Ib88bb7d12faaac7d149ee1f6379bc128b83bbdd5
This repository contains Python programs that can be used to read, program (write) and browse certain fields/parameters on so-called programmable SIM/USIM cards.
Such SIM/USIM cards are special cards, which - unlike those issued by regular commercial operators - come with the kind of keys that allow you to write the files/fields that normally only an operator can program.
This is useful particularly if you are running your own cellular network, and want to issue your own SIM/USIM cards for that network.
Please visit the official homepage for usage instructions, manual and examples.
You can clone from the official Osmocom git repository using
git clone git://git.osmocom.org/pysim.git
There is a cgit interface at https://git.osmocom.org/pysim
Please install the following dependencies:
Example for Debian:
apt-get install python3-pyscard python3-serial python3-pip python3-yaml pip3 install -r requirements.txt
After installing all dependencies, the pySim applications pySim-read.py
, pySim-prog.py
and pySim-shell.py
may be started directly from the cloned repository.
Archlinux users may install the package python-pysim-git
from the Arch User Repository (AUR). The most convenient way is the use of an AUR Helper, e.g. yay or pacaur. The following example shows the installation with yay
.
# Install yay -Sy python-pysim-git # Uninstall sudo pacman -Rs python-pysim-git
There is no separate mailing list for this project. However, discussions related to pysim-prog are happening on the openbsc@lists.osmocom.org mailing list, please see https://lists.osmocom.org/mailman/listinfo/openbsc for subscription options and the list archive.
Please observe the Osmocom Mailing List Rules when posting.
Our coding standards are described at https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards
We are using a gerrit-based patch review process explained at https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit
The pySim user manual can be built from this very source code by means of sphinx (with sphinxcontrib-napoleon and sphinx-argparse). See the Makefile in the 'docs' directory.
A pre-rendered HTML user manual of the current pySim 'git master' is available from https://downloads.osmocom.org/docs/latest/pysim/ and a downloadable PDF version is published at https://downloads.osmocom.org/docs/latest/osmopysim-usermanual.pdf.
A slightly dated video presentation about pySim-shell can be found at https://media.ccc.de/v/osmodevcall-20210409-laforge-pysim-shell.
While you will find a lot of online resources still describing the use of pySim-prog.py and pySim-read.py, those tools are considered legacy by now and have by far been superseded by the much more capable pySim-shell. We strongly encourage users to adopt pySim-shell, unless they have very specific requirements like batch programming of large quantities of cards, which is about the only remaining use case for the legacy tools.