CI: disable PyPy3

There are some test-related issues with it, so disable it for now.
CI: prefer pip to Debian packages
2018-11-13 03:16:52 +01:00 · 2018-11-13 03:07:06 +01:00 · 2018-11-13 02:59:32 +01:00 · 2018-11-13 02:52:46 +01:00 · 2018-11-13 02:20:42 +01:00 · 2018-11-09 01:14:41 +01:00
3 changed files with 21 additions and 5 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -7,11 +7,10 @@ python:
  - "3.4"
  - "3.5"
  - "3.6"
-  - "pypy3"
-before_install:
-  - sudo apt install rpm dpkg-dev debhelper dh-python python3-setuptools fakeroot python3-serial python3-yaml
+  #- "pypy3"
 install:
-  - pip install pyusb
+  - pip install pyusb coverage coveralls pyserial PyYAML tqdm
 script:
  - python setup.py build
-  - python setup.py test
+  - coverage run --source=stcgal setup.py test
+  - coveralls
--- a/README.md
+++ b/README.md
@ -1,4 +1,6 @@
 [![Build Status](https://travis-ci.org/grigorig/stcgal.svg)](https://travis-ci.org/grigorig/stcgal)
+[![Coverage Status](https://coveralls.io/repos/github/grigorig/stcgal/badge.svg?branch=coveralls)](https://coveralls.io/github/grigorig/stcgal?branch=coveralls)
+[![PyPI version](https://badge.fury.io/py/stcgal.svg)](https://badge.fury.io/py/stcgal)

 stcgal - STC MCU ISP flash tool
 ===============================
@ -32,6 +34,17 @@ Features
 * Automatic power-cycling with DTR toggle or a custom shell command
 * Automatic UART protocol detection

+Quickstart
+----------
+
+Install stcgal (might need root/administrator privileges):
+    
+    pip3 install stcgal
+
+Call stcgal and show usage:
+
+    stcgal -h
+
 Further information
 -------------------

--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@ -20,6 +20,10 @@ Interfaces that are known to not work:

 In general, stcgal requires accurate baud rate timings and parity support.

+### stcgal fails to start with the error `module 'serial' has no attribute 'PARITY_NONE'` or similar
+
+There is a module name conflict between the PyPI package 'serial' (a data serialization library) and the PyPI package 'pyserial' (the serial port access library needed by stcgal). You have to uninstall the 'serial' package (`pip3 uninstall serial`) and reinstall 'pyserial' (`pip3 install --force-reinstall pyserial`) to fix this. There is no other known solution at the moment.
+
 ### stcgal fails to recognize the MCU and is stuck at "Waiting for MCU"

 There are a number of issues that can result in this symptom:
Author	SHA1	Message	Date
Grigori Goronzy	7e413b09ec	CI: disable PyPy3 There are some test-related issues with it, so disable it for now.	2018-11-13 03:16:52 +01:00
Grigori Goronzy	3aa08b67c0	CI: prefer pip to Debian packages According to Travis CI docs, pip should be preferred.	2018-11-13 03:07:06 +01:00
Grigori Goronzy	42f93bc481	Add coveralls badge to README	2018-11-13 02:59:32 +01:00
Grigori Goronzy	dbfc1b3f50	CI: Add coveralls support	2018-11-13 02:52:46 +01:00
Grigori Goronzy	9d47588ad2	Add PyPI badge to README	2018-11-13 02:20:42 +01:00
Grigori Goronzy	217e5fb17e	CI: try to fix and simplify apt setup Run apt update to update the package cache, as this seems to be needed by Travis now. Also reduce the package set - we don't build any deb or rpm packages anymore. This should hopefully fix the CI build.	2018-11-09 01:14:41 +01:00
Grigori Goronzy	3875b1f415	Note serial module name conflict in FAQ See #35 for discussion.	2018-11-09 01:02:01 +01:00
Grigori Goronzy	8e31765cba	Add Quickstart documentation	2018-09-24 23:29:45 +02:00