Skip to content

Commit

Permalink
Update packaging data for PyPI
Browse files Browse the repository at this point in the history
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
  • Loading branch information
grigorig committed Sep 23, 2018
1 parent 4cc0deb commit e0e2ab5
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
18 changes: 18 additions & 0 deletions doc/PyPI.md
Original file line number Diff line number Diff line change
@@ -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).
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
},
Expand All @@ -50,7 +51,7 @@
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",
Expand Down

0 comments on commit e0e2ab5

Please sign in to comment.