mirror of
https://github.com/markqvist/NomadNet.git
synced 2025-01-22 20:41:08 -05:00
Initial commit
This commit is contained in:
commit
3ab47d4cc5
7
.gitignore
vendored
Executable file
7
.gitignore
vendored
Executable file
@ -0,0 +1,7 @@
|
||||
*.DS_Store
|
||||
*.pyc
|
||||
testutils
|
||||
TODO
|
||||
build
|
||||
dist
|
||||
rns*.egg-info
|
29
README.md
Executable file
29
README.md
Executable file
@ -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.
|
7
nomadnet/__init__.py
Normal file
7
nomadnet/__init__.py
Normal file
@ -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')]
|
7
nomadnet/nomadnet.py
Normal file
7
nomadnet/nomadnet.py
Normal file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
def main():
|
||||
pass
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
26
setup.py
Normal file
26
setup.py
Normal file
@ -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',
|
||||
)
|
Loading…
Reference in New Issue
Block a user