generate readme in a form PyPi likes

This commit is contained in:
geeksville
2020-04-28 13:40:14 -07:00
parent d578166fbf
commit 981c65033a
5 changed files with 10 additions and 13 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
README

View File

@@ -3,9 +3,13 @@
## Before initial release
- add fromId and toId to received messages dictionaries
- update nodedb as nodes change
- make docs decent
- keep everything in dicts
- document properties/fields
- include examples in readme. hello.py, textchat.py, replymessage.py
- include examples in readme. hello.py, textchat.py, replymessage.py all as one little demo
- have python client turn off radio sleep (use 0 for X to mean restore defaults)
- announce various places
- DONE use port enumeration to find ports https://pyserial.readthedocs.io/en/latest/shortintro.html
- DONE make serial debug output optional (by providing a null stream)
- DONE make pubsub work

View File

@@ -18,11 +18,7 @@ BROADCAST_ADDR = "all" # A special ID that means broadcast
"""
TODO:
Contains a reader thread that is always trying to read on the serial port.
methods:
properties:
- radioConfig - getter/setter syntax: https://www.python-course.eu/python3_properties.php
- nodes - the database of received nodes

View File

@@ -4,16 +4,11 @@ from setuptools import setup
# The directory containing this file
HERE = pathlib.Path(__file__).parent
# The text of the README file
README = (HERE / "README.md").read_text()
# This call to setup() does all the work
setup(
name="ezdevice",
version="0.0.7",
name="meshtastic",
version="0.5.0",
description="Python API & client shell for talking to Meshtastic devices",
long_description=README,
long_description_content_type="text/markdown",
url="https://github.com/meshtastic/Meshtastic-python",
author="Kevin Hester",
author_email="kevinh@geeksville.com",

View File

@@ -1,4 +1,5 @@
rm dist/*
set -e
pandoc --from=markdown --to=rst --output=README README.md
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*