From 3ab47d4cc5d972aa0b6510cd50448fe3d5b8ca41 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sat, 27 Mar 2021 10:58:13 +0100 Subject: [PATCH] Initial commit --- .gitignore | 7 +++++++ README.md | 29 +++++++++++++++++++++++++++++ nomadnet/__init__.py | 7 +++++++ nomadnet/nomadnet.py | 7 +++++++ setup.py | 26 ++++++++++++++++++++++++++ 5 files changed, 76 insertions(+) create mode 100755 .gitignore create mode 100755 README.md create mode 100644 nomadnet/__init__.py create mode 100644 nomadnet/nomadnet.py create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..fa55598 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.DS_Store +*.pyc +testutils +TODO +build +dist +rns*.egg-info diff --git a/README.md b/README.md new file mode 100755 index 0000000..ee73920 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +Nomad Network +========== + +General introduction to Nomad Network + +Nomad Network is built using Reticulum, see [unsigned.io/projects/reticulum](https://unsigned.io/projects/reticulum/). + +## Notable Features + - List of notable features + - More features + +## Dependencies: + - Python 3 + - RNS + - LXMF + +## How do I get started? +The easiest way to install Nomad Network is via pip: + +```bash +# Install Nomad Network and dependencies +pip3 install nomadnet + +# Run the client +nomadnet +``` + +## Caveat Emptor +Nomad Network is experimental software, and should be considered as such. 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 diff --git a/nomadnet/__init__.py b/nomadnet/__init__.py new file mode 100644 index 0000000..76fac94 --- /dev/null +++ b/nomadnet/__init__.py @@ -0,0 +1,7 @@ +import os +import glob + +from .nomadnet import * + +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/nomadnet/nomadnet.py b/nomadnet/nomadnet.py new file mode 100644 index 0000000..f8b06d4 --- /dev/null +++ b/nomadnet/nomadnet.py @@ -0,0 +1,7 @@ +#!/usr/bin/env python3 + +def main(): + pass + +if __name__ == "__main__": + main() diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..16bc872 --- /dev/null +++ b/setup.py @@ -0,0 +1,26 @@ +import setuptools + +with open("README.md", "r") as fh: + long_description = fh.read() + +setuptools.setup( + name="nomadnet", + version="0.0.1", + author="Mark Qvist", + author_email="mark@unsigned.io", + description="Communicate freely", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/markqvist/nomadnet", + packages=setuptools.find_packages(), + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + ], + entry_points= { + 'console_scripts': ['nomadnet=nomadnet:main'] + }, + install_requires=['rns', 'lxmf'], + python_requires='>=3.5', +) \ No newline at end of file