From aecb142229c3b182b1d22a7fda70b99ccd292142 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 29 Apr 2020 12:57:06 +0200 Subject: [PATCH] Restructured as package --- .gitignore | 1 + LXMF.py => LXMF/LXMF.py | 0 LXMF/__init__.py | 7 +++++++ README.html | 4 ++++ README.md | 10 +++++++++- setup.py | 23 +++++++++++++++++++++++ 6 files changed, 44 insertions(+), 1 deletion(-) rename LXMF.py => LXMF/LXMF.py (100%) create mode 100644 LXMF/__init__.py create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index b6e4761..45efbd4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.DS_Store # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/LXMF.py b/LXMF/LXMF.py similarity index 100% rename from LXMF.py rename to LXMF/LXMF.py diff --git a/LXMF/__init__.py b/LXMF/__init__.py new file mode 100644 index 0000000..a304c21 --- /dev/null +++ b/LXMF/__init__.py @@ -0,0 +1,7 @@ +import os +import glob +from .LXMF import LXMessage +from .LXMF import LXMRouter + +modules = glob.glob(os.path.dirname(__file__)+"/*.py") +__all__ = [ os.path.basename(f)[:-3] for f in modules if not f.endswith('__init__.py')] \ No newline at end of file diff --git a/README.html b/README.html index 2c15a78..2ad08fe 100644 --- a/README.html +++ b/README.html @@ -841,4 +841,8 @@ lxm_router.handle_outbound(message)

Caveat Emptor

As with Reticulum, LXMF is alpha software, and should be considered experimental. While it has been built with cryptography best-practices very foremost in mind, it has not been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.

+

+Installation

+

If you want to try out LXMF, you can install it with pip:

+
pip3 install lxmf
\ No newline at end of file diff --git a/README.md b/README.md index aa395a3..b49a6c5 100644 --- a/README.md +++ b/README.md @@ -95,4 +95,12 @@ The complete message overhead for LXMF is only 163 bytes, which in return gives ## Caveat Emptor -As with Reticulum, LXMF is alpha software, and should be considered experimental. While it has been built with cryptography best-practices very foremost in mind, it _has not_ been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch. \ No newline at end of file +As with Reticulum, LXMF is alpha software, and should be considered experimental. While it has been built with cryptography best-practices very foremost in mind, it _has not_ been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch. + +## Installation + +If you want to try out LXMF, you can install it with pip: + +```bash +pip3 install lxmf +``` \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..36148ab --- /dev/null +++ b/setup.py @@ -0,0 +1,23 @@ +import setuptools + +with open("README.md", "r") as fh: + long_description = fh.read() + +setuptools.setup( + name="lxmf", + version="0.0.1", + author="Mark Qvist", + author_email="mark@unsigned.io", + description="Lightweight Extensible Message Format for Reticulum", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/markqvist/lxmf", + packages=setuptools.find_packages(), + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + ], + install_requires=['rns'], + python_requires='>=3.6', +) \ No newline at end of file