Update packaging data for PyPI

This makes some minor adjustments, plus some general updates. In short:

* Mark stcgal as stable
* Make tqdm and pyserial requirements more specific
* Add a new long description, specific for PyPI
* Add documentation files to distribution
This commit is contained in:
Grigori Goronzy 2018-09-23 22:02:09 +02:00
parent 4cc0deb8e9
commit e0e2ab5526
2 changed files with 22 additions and 3 deletions

18
doc/PyPI.md Normal file
View File

@ -0,0 +1,18 @@
stcgal - STC MCU ISP flash tool
===============================
stcgal is a command line flash programming tool for [STC MCU Ltd](http://stcmcu.com/).
8051 compatible microcontrollers.
STC microcontrollers have an UART/USB based boot strap loader (BSL). It
utilizes a packet-based protocol to flash the code memory and IAP
memory over a serial link. This is referred to as in-system programming
(ISP). The BSL is also used to configure various (fuse-like) device
options. Unfortunately, this protocol is not publicly documented and
STC only provide a (crude) Windows GUI application for programming.
stcgal is a full-featured Open Source replacement for STC's Windows
software; it supports a wide range of MCUs, it is very portable and
suitable for automation.
[See the GitHub page for more information](https://github.com/grigorig/stcgal).

View File

@ -24,14 +24,15 @@
import stcgal
from setuptools import setup, find_packages
with open("README.md", "r") as fh:
with open("doc/PyPI.md", "r") as fh:
long_description = fh.read()
setup(
name = "stcgal",
version = stcgal.__version__,
packages = find_packages(exclude=["doc", "tests"]),
install_requires = ["pyserial", "tqdm"],
data_files = [("doc", ["README.md", "doc/FAQ.md", "doc/MODELS.md", "doc/USAGE.md"])],
install_requires = ["pyserial>=3.0", "tqdm>=4.0.0"],
extras_require = {
"usb": ["pyusb>=1.0.0"]
},
@ -50,7 +51,7 @@ setup(
license = "MIT License",
platforms = "any",
classifiers = [
"Development Status :: 4 - Beta",
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",