mirror of
https://github.com/markqvist/LXMF.git
synced 2025-05-23 00:01:16 -04:00
Restructured as package
This commit is contained in:
parent
4589610b1f
commit
aecb142229
6 changed files with 44 additions and 1 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,3 +1,4 @@
|
||||||
|
.DS_Store
|
||||||
# Byte-compiled / optimized / DLL files
|
# Byte-compiled / optimized / DLL files
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
|
|
7
LXMF/__init__.py
Normal file
7
LXMF/__init__.py
Normal file
|
@ -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')]
|
|
@ -841,4 +841,8 @@ lxm_router.handle_outbound(message)
|
||||||
<h2>
|
<h2>
|
||||||
<a id="user-content-caveat-emptor" class="anchor" href="#caveat-emptor" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Caveat Emptor</h2>
|
<a id="user-content-caveat-emptor" class="anchor" href="#caveat-emptor" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Caveat Emptor</h2>
|
||||||
<p>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 <em>has not</em> 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.</p>
|
<p>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 <em>has not</em> 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.</p>
|
||||||
|
<h2>
|
||||||
|
<a id="user-content-installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h2>
|
||||||
|
<p>If you want to try out LXMF, you can install it with pip:</p>
|
||||||
|
<div class="highlight highlight-source-shell"><pre>pip3 install lxmf</pre></div>
|
||||||
</article></body></html>
|
</article></body></html>
|
10
README.md
10
README.md
|
@ -95,4 +95,12 @@ The complete message overhead for LXMF is only 163 bytes, which in return gives
|
||||||
|
|
||||||
## Caveat Emptor
|
## 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.
|
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
|
||||||
|
```
|
23
setup.py
Normal file
23
setup.py
Normal file
|
@ -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',
|
||||||
|
)
|
Loading…
Add table
Add a link
Reference in a new issue