From f23612071131b7565d07254e1842803614a42597 Mon Sep 17 00:00:00 2001 From: varkenvarken Date: Fri, 1 Jul 2022 16:33:35 +0200 Subject: [PATCH] initial version for pypi --- .gitignore | 6 ++++++ README.md | 10 +++++++--- setup.py | 16 ++++++++++++++++ 3 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 69ea22f..798ef35 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,9 @@ *.pyc +# Setuptools distribution folder. +/dist/ + +# Python egg metadata, regenerated from source files by setuptools. +/*.egg-info + drawings/*.bkp diff --git a/README.md b/README.md index d3a26b6..072e0e8 100644 --- a/README.md +++ b/README.md @@ -82,19 +82,23 @@ One of the pieces of information in a slot is the decoder address of the locomot - [pyserial](https://github.com/pyserial/pyserial) # installation -TODO + +```bash +pip install pylnlib +``` # example programs A simple monitor program can be run directly ```bash python –m pylnlib ``` -this program can also capture and store the network data to a file and replay this file. For more optionsntype + +This program can also capture and store the network data to a file and replay this file. For more options type ```bash python -m pylnlib --help ``` -The scripts directory also contains sample programs that use the library and automate some activities. +The [scripts directory](https://github.com/varkenvarken/pylnlib/tree/master/scripts) also contains sample programs that use the library and automate some activities. # capture and replay diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..8250f3e --- /dev/null +++ b/setup.py @@ -0,0 +1,16 @@ +from setuptools import setup + +setup( + name="pylnlib", + version="0.1.1", + description="A library to monitor LocoNet message on a serial interface", + url="https://github.com/varkenvarken/pylnlib", + author="varkenvarken", + author_email="test@example.com", + license="GPLv3", + packages=["pylnlib"], + install_requires=[ + "pyserial", + ], + zip_safe=False, +)