docs: both install paths (release package / clone) + Windows notes refreshed
The READMEs told users to clone the repository even though most just want to run the app. The Quick start now leads with the release package (a snapshot of the tagged source: no git history, no development files) and keeps the clone path for development or unreleased changes; git is still required because setup installs pysim from its upstream repository. Windows notes refreshed against the actual tooling and PyPI: - pyscard 2.3.1 ships cp39-cp313 wheels (no cp314) and requires Python >= 3.9, so the pip/pyproject floor is 3.9 now (3.8 could never install the dependency) and the "3.9 builds from source" note is gone - only 3.14 does. - The reader sentence now describes what actually happens: start.sh asks for the first PC/SC reader when pcscd runs, the server auto-detects a PC/SC reader itself, and with none present pysim falls back to its serial default /dev/ttyUSB0 (use -d for a serial/FTDI reader). - The manual-install block is marked Linux/macOS: on Windows pysim is installed via requirements-pysim.txt + --no-deps (setup.bat), since the plain pip route pulls the SMPP bridge and its MSVC chain. Docs/metadata only: 953 frontend + 989 Python green.
This commit is contained in:
+28
-9
@@ -15,13 +15,28 @@ SIMple — инструментарий для специалистов по UIC
|
||||
|
||||
**Только PWA (клиентские функции):** откройте `frontend/index.html` в любом браузере или раздайте `frontend/` любым статическим сервером. Python не нужен.
|
||||
|
||||
**Полная установка (PWA + сервер карт):**
|
||||
**Полная установка (PWA + сервер карт)** — два способа:
|
||||
|
||||
**1. Скачать релизный пакет (рекомендуется).** На странице
|
||||
[Releases](https://github.com/anttro/simple/releases) возьмите последний пакет (ZIP),
|
||||
распакуйте в любое место и один раз запустите setup:
|
||||
|
||||
```sh
|
||||
./setup.sh # или setup.bat в Windows — создаёт .venv, ставит pysim + сервер
|
||||
./start.sh # или start.bat — запускает сервер (он же раздаёт PWA)
|
||||
```
|
||||
|
||||
Пакет собран из помеченного тегом исходного кода — без истории git и без файлов для
|
||||
разработки. Git всё равно нужен: `setup` ставит **pysim** из его upstream-репозитория
|
||||
(ни pysim, ни его зависимости в пакет не входят).
|
||||
|
||||
**2. Клонировать репозиторий (для разработки или ещё не выпущенных изменений).**
|
||||
|
||||
```sh
|
||||
git clone https://github.com/anttro/simple.git
|
||||
cd simple
|
||||
./setup.sh # или setup.bat в Windows — создаёт .venv, ставит pysim + сервер
|
||||
./start.sh # или start.bat — запускает сервер (он же раздаёт PWA)
|
||||
./setup.sh # или setup.bat в Windows
|
||||
./start.sh # или start.bat
|
||||
```
|
||||
|
||||
Затем откройте http://127.0.0.1:8080 — интерфейс и API на одном origin, поэтому CORS и разрешения браузера не нужны. Сервер запускается и с пустым картридером (отсутствие карты — нормальное состояние): вставьте карту, и она инициализируется автоматически (auto-equip), либо нажмите **Equip card** в интерфейсе.
|
||||
@@ -707,29 +722,33 @@ PWA проверяет версию сервера при подключении
|
||||
|
||||
### Требования
|
||||
|
||||
- **Python 3.8+** с `pip`, и **Git**
|
||||
- **Python 3.9+** с `pip`, и **Git**
|
||||
- **Смарт-картридер** (PC/SC или serial/FTDI) — предпочтителен PC/SC (`pcsc-lite` + `ccid` на Linux)
|
||||
- **Windows** — используйте Python 3.10–3.13 (рекомендуется 3.13): у `pyscard` есть готовые wheel. На 3.9 / 3.14 он собирается из исходников (нужны MSVC C++ Build Tools). SMPP-мост (`smpp.twisted3`) в Windows сознательно не ставится.
|
||||
- **Windows** — используйте Python 3.9–3.13 (рекомендуется 3.13): у `pyscard` есть готовые wheel. На 3.14 он собирается из исходников (нужны MSVC C++ Build Tools). SMPP-мост (`smpp.twisted3`) в Windows сознательно не ставится.
|
||||
|
||||
### Скрипты
|
||||
|
||||
| Скрипт | Назначение |
|
||||
|--------|-------------|
|
||||
| `setup.sh` / `setup.bat` | Создаёт `.venv/`, ставит pysim и сервер. Запускать один раз после клонирования. |
|
||||
| `setup.sh` / `setup.bat` | Создаёт `.venv/`, ставит pysim и сервер. Запускать один раз после клонирования или распаковки релизного пакета. |
|
||||
| `start.sh` / `start.bat` | Запускает сервер из venv (раздаёт PWA + API на `:8080`). |
|
||||
|
||||
`start.sh` автоопределяет ридер (PC/SC при работающем `pcscd`, иначе `/dev/ttyUSB0`); `start.bat` всегда использует `-p 0`. Дополнительные аргументы передаются серверу, например `./start.sh --gsmtap` или `start.bat --gsmtap 10.0.0.5:4729`. Без ридера сервер всё равно стартует («Reader: none») — карту можно инициализировать позже кнопкой **Equip**.
|
||||
`start.sh` при работающем `pcscd` запрашивает первый PC/SC-ридер; иначе сервер сам автоопределяет PC/SC-ридер, а если его нет — pysim откатывается на последовательное устройство по умолчанию `/dev/ttyUSB0` (для serial/FTDI-ридера укажите `-d <устройство>`). `start.bat` всегда передаёт `-p 0`. Дополнительные аргументы передаются серверу, например `./start.sh --gsmtap` или `start.bat --gsmtap 10.0.0.5:4729`. Без ридера сервер всё равно стартует («Reader: none») — карту можно инициализировать позже кнопкой **Equip**.
|
||||
|
||||
### Ручная установка
|
||||
### Ручная установка (Linux/macOS)
|
||||
|
||||
```sh
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate # Linux/macOS (Windows: .venv\Scripts\activate)
|
||||
source .venv/bin/activate
|
||||
pip install git+https://github.com/osmocom/pysim.git
|
||||
pip install -e . # editable — раздаёт frontend/ из исходного дерева
|
||||
pysim-simple-server --http-port 8080
|
||||
```
|
||||
|
||||
В Windows используйте `setup.bat`: он ставит зависимости pysim из
|
||||
`requirements-pysim.txt`, а сам pysim — с `--no-deps`, поэтому SMPP-мост (и его сборка
|
||||
через MSVC) не подтягивается.
|
||||
|
||||
### Параметры CLI
|
||||
|
||||
| Параметр | Описание |
|
||||
|
||||
Reference in New Issue
Block a user