mirror of
https://github.com/markqvist/NomadNet.git
synced 2025-12-17 14:54:26 +01:00
Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
24d850107d | ||
|
|
9943cad15f | ||
|
|
dcd5f7df95 | ||
|
|
d840ca32ae | ||
|
|
37063932bb | ||
|
|
0ed4e09b82 | ||
|
|
910e527cc7 | ||
|
|
4eef326d6b | ||
|
|
691f4df098 | ||
|
|
407cc8fb5f | ||
|
|
1f7302903a |
19
README.md
19
README.md
@@ -22,9 +22,6 @@ If you'd rather want to use an LXMF client with a graphical user interface, you
|
|||||||
- An easy to use and bandwidth efficient markup language for writing pages
|
- An easy to use and bandwidth efficient markup language for writing pages
|
||||||
- Page caching in browser
|
- Page caching in browser
|
||||||
|
|
||||||
## Current Status
|
|
||||||
The current version of the program should be considered a beta release. The program works well, but there will most probably be bugs and possibly sub-optimal performance in some scenarios. On the other hand, this is the ideal time to have an influence on the direction of the development of Nomad Network. To do so, join the discussion, report bugs and request features here on the GitHub project.
|
|
||||||
|
|
||||||
## How do I get started?
|
## How do I get started?
|
||||||
The easiest way to install Nomad Network is via pip:
|
The easiest way to install Nomad Network is via pip:
|
||||||
|
|
||||||
@@ -121,6 +118,22 @@ $ docker run -d \
|
|||||||
$ docker run -i ghcr.io/markqvist/nomadnet:master --daemon --console
|
$ docker run -i ghcr.io/markqvist/nomadnet:master --daemon --console
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Tools & Extensions
|
||||||
|
|
||||||
|
Nomad Network is a very flexible and extensible platform, and a variety of community-provided tools, utilities and node-side extensions exist:
|
||||||
|
|
||||||
|
- [NomadForum](https://codeberg.org/AutumnSpark1226/nomadForum) ([GitHub mirror](https://github.com/AutumnSpark1226/nomadForum))
|
||||||
|
- [NomadForecast](https://github.com/faragher/NomadForecast)
|
||||||
|
- [micron-blog](https://github.com/randogoth/micron-blog)
|
||||||
|
- [md2mu](https://github.com/randogoth/md2mu)
|
||||||
|
- [Any2MicronConverter](https://github.com/SebastianObi/Any2MicronConverter)
|
||||||
|
- [Some nomadnet page examples](https://github.com/SebastianObi/NomadNet-Pages)
|
||||||
|
- [More nomadnet page examples](https://github.com/epenguins/NomadNet_pages)
|
||||||
|
- [LXMF-Bot](https://github.com/randogoth/lxmf-bot)
|
||||||
|
- [LXMF Messageboard](https://github.com/chengtripp/lxmf_messageboard)
|
||||||
|
- [LXMEvent](https://github.com/faragher/LXMEvent)
|
||||||
|
- [LXMF Tools](https://github.com/SebastianObi/LXMF-Tools)
|
||||||
|
|
||||||
## Help & Discussion
|
## Help & Discussion
|
||||||
|
|
||||||
For help requests, discussion, sharing ideas or anything else related to Nomad Network, please have a look at the [Nomad Network discussions pages](https://github.com/markqvist/Reticulum/discussions/categories/nomad-network).
|
For help requests, discussion, sharing ideas or anything else related to Nomad Network, please have a look at the [Nomad Network discussions pages](https://github.com/markqvist/Reticulum/discussions/categories/nomad-network).
|
||||||
|
|||||||
@@ -50,6 +50,8 @@ class Node:
|
|||||||
|
|
||||||
|
|
||||||
def register_pages(self):
|
def register_pages(self):
|
||||||
|
# TODO: Deregister previously registered pages
|
||||||
|
# that no longer exist.
|
||||||
self.servedpages = []
|
self.servedpages = []
|
||||||
self.scan_pages(self.app.pagespath)
|
self.scan_pages(self.app.pagespath)
|
||||||
|
|
||||||
@@ -69,6 +71,8 @@ class Node:
|
|||||||
)
|
)
|
||||||
|
|
||||||
def register_files(self):
|
def register_files(self):
|
||||||
|
# TODO: Deregister previously registered files
|
||||||
|
# that no longer exist.
|
||||||
self.servedfiles = []
|
self.servedfiles = []
|
||||||
self.scan_files(self.app.filespath)
|
self.scan_files(self.app.filespath)
|
||||||
|
|
||||||
@@ -230,10 +234,12 @@ class Node:
|
|||||||
if self.page_refresh_interval > 0:
|
if self.page_refresh_interval > 0:
|
||||||
if now > self.last_page_refresh + self.page_refresh_interval*60:
|
if now > self.last_page_refresh + self.page_refresh_interval*60:
|
||||||
self.register_pages()
|
self.register_pages()
|
||||||
|
self.last_page_refresh = time.time()
|
||||||
|
|
||||||
if self.file_refresh_interval > 0:
|
if self.file_refresh_interval > 0:
|
||||||
if now > self.last_file_refresh + self.file_refresh_interval*60:
|
if now > self.last_file_refresh + self.file_refresh_interval*60:
|
||||||
self.register_files()
|
self.register_files()
|
||||||
|
self.last_file_refresh = time.time()
|
||||||
|
|
||||||
time.sleep(self.job_interval)
|
time.sleep(self.job_interval)
|
||||||
|
|
||||||
|
|||||||
@@ -1077,6 +1077,22 @@ announce_at_start = Yes
|
|||||||
# and generally you do not need to use it.
|
# and generally you do not need to use it.
|
||||||
# prioritise_destinations = 41d20c727598a3fbbdf9106133a3a0ed, d924b81822ca24e68e2effea99bcb8cf
|
# prioritise_destinations = 41d20c727598a3fbbdf9106133a3a0ed, d924b81822ca24e68e2effea99bcb8cf
|
||||||
|
|
||||||
|
# Automatic rescan interval of the pages directory in minutes.
|
||||||
|
# Default: int = 0 (no rescan)
|
||||||
|
page_refresh_interval = 0
|
||||||
|
|
||||||
|
# You can specify the interval in minutes for
|
||||||
|
# rescanning the hosted pages path. By default,
|
||||||
|
# this option is disabled, and the pages path
|
||||||
|
# will only be scanned on startup.
|
||||||
|
# page_refresh_interval = 0
|
||||||
|
|
||||||
|
# You can specify the interval in minutes for
|
||||||
|
# rescanning the hosted files path. By default,
|
||||||
|
# this option is disabled, and the files path
|
||||||
|
# will only be scanned on startup.
|
||||||
|
# file_refresh_interval = 0
|
||||||
|
|
||||||
[printing]
|
[printing]
|
||||||
|
|
||||||
# You can configure Nomad Network to print
|
# You can configure Nomad Network to print
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
__version__ = "0.4.3"
|
__version__ = "0.4.5"
|
||||||
|
|||||||
@@ -163,9 +163,8 @@ class GuideDisplay():
|
|||||||
entry.display_topic(entry.display_topic, entry.topic_name)
|
entry.display_topic(entry.display_topic, entry.topic_name)
|
||||||
|
|
||||||
def set_content_widgets(self, new_content):
|
def set_content_widgets(self, new_content):
|
||||||
options = self.columns.options(width_type="weight", width_amount=1-GuideDisplay.list_width)
|
options = self.columns.options(width_type="weight", width_amount=1-GuideDisplay.list_width, box_widget=True)
|
||||||
pile = urwid.Pile(new_content)
|
pile = urwid.Pile(new_content)
|
||||||
#content = urwid.LineBox(urwid.Filler(pile, "top"))
|
|
||||||
content = urwid.LineBox(urwid.AttrMap(ScrollBar(Scrollable(pile), thumb_char="\u2503", trough_char=" "), "scrollbar"))
|
content = urwid.LineBox(urwid.AttrMap(ScrollBar(Scrollable(pile), thumb_char="\u2503", trough_char=" "), "scrollbar"))
|
||||||
|
|
||||||
self.columns.contents[1] = (content, options)
|
self.columns.contents[1] = (content, options)
|
||||||
@@ -398,7 +397,7 @@ You're currently located in the guide section of the program. I'm sorry I had to
|
|||||||
|
|
||||||
To get the most out of Nomad Network, you will need a terminal that supports UTF-8 and at least 256 colors, ideally true-color. If your terminal supports true-color, you can go to the `![ Config ]`! menu item, launch the editor and change the configuration.
|
To get the most out of Nomad Network, you will need a terminal that supports UTF-8 and at least 256 colors, ideally true-color. If your terminal supports true-color, you can go to the `![ Config ]`! menu item, launch the editor and change the configuration.
|
||||||
|
|
||||||
It is recommended to use a terminal size of at least 122x32. Nomad Network will work with smaller terminal sizes, but the interface might feel a bit cramped.
|
It is recommended to use a terminal size of at least 135x32. Nomad Network will work with smaller terminal sizes, but the interface might feel a bit cramped.
|
||||||
|
|
||||||
If you don't already have a Nerd Font installed (see https://www.nerdfonts.com/), I also highly recommend to do so, since it will greatly expand the amount of glyphs, icons and graphics that Nomad Network can use. Once you have your terminal set up with a Nerd Font, go to the `![ Config ]`! menu item and enable Nerd Fonts in the configuration instead of normal unicode glyphs.
|
If you don't already have a Nerd Font installed (see https://www.nerdfonts.com/), I also highly recommend to do so, since it will greatly expand the amount of glyphs, icons and graphics that Nomad Network can use. Once you have your terminal set up with a Nerd Font, go to the `![ Config ]`! menu item and enable Nerd Fonts in the configuration instead of normal unicode glyphs.
|
||||||
|
|
||||||
@@ -624,7 +623,7 @@ Determines where the node server will look for hosted pages. Must be a readable
|
|||||||
>>>
|
>>>
|
||||||
`!page_refresh_interval = 0`!
|
`!page_refresh_interval = 0`!
|
||||||
>>>>
|
>>>>
|
||||||
Determines the interval in seconds for rescanning the hosted pages path. By default, this option is disabled, and the pages path will only be scanned on startup.
|
Determines the interval in minutes for rescanning the hosted pages path. By default, this option is disabled, and the pages path will only be scanned on startup.
|
||||||
<
|
<
|
||||||
|
|
||||||
>>>
|
>>>
|
||||||
@@ -636,7 +635,7 @@ Determines where the node server will look for downloadable files. Must be a rea
|
|||||||
>>>
|
>>>
|
||||||
`!file_refresh_interval = 0`!
|
`!file_refresh_interval = 0`!
|
||||||
>>>>
|
>>>>
|
||||||
Determines the interval in seconds for rescanning the hosted files path. By default, this option is disabled, and the files path will only be scanned on startup.
|
Determines the interval in minutes for rescanning the hosted files path. By default, this option is disabled, and the files path will only be scanned on startup.
|
||||||
<
|
<
|
||||||
|
|
||||||
>>>
|
>>>
|
||||||
@@ -1156,7 +1155,7 @@ To display literal content, for example source-code, or blocks of text that shou
|
|||||||
`=
|
`=
|
||||||
'''
|
'''
|
||||||
TOPIC_MARKUP += TOPIC_MARKUP.replace("`=", "\\`=") + "[ micron source for document goes here, we don't want infinite recursion now, do we? ]\n\\`="
|
TOPIC_MARKUP += TOPIC_MARKUP.replace("`=", "\\`=") + "[ micron source for document goes here, we don't want infinite recursion now, do we? ]\n\\`="
|
||||||
TOPIC_MARKUP += "\n`=\n\n>Closing Remarks\n\nIf you made it all the way here, you should be well equipped to write documents, pages and applications using micron and Nomad Network. Thank you for staying with me.\n\n`c\U0001F332\n"
|
TOPIC_MARKUP += "\n`=\n\n>Closing Remarks\n\nIf you made it all the way here, you should be well equipped to write documents, pages and applications using micron and Nomad Network. Thank you for staying with me.\n"
|
||||||
|
|
||||||
|
|
||||||
TOPICS = {
|
TOPICS = {
|
||||||
|
|||||||
@@ -12,11 +12,22 @@ class LogDisplay():
|
|||||||
def __init__(self, app):
|
def __init__(self, app):
|
||||||
import urwid
|
import urwid
|
||||||
self.app = app
|
self.app = app
|
||||||
self.log_term = LogTerminal(self.app)
|
self.log_term = None
|
||||||
|
|
||||||
self.shortcuts_display = LogDisplayShortcuts(self.app)
|
self.shortcuts_display = LogDisplayShortcuts(self.app)
|
||||||
|
self.widget = None
|
||||||
|
|
||||||
|
def show(self):
|
||||||
|
if self.log_term == None:
|
||||||
|
self.log_term = LogTerminal(self.app)
|
||||||
self.widget = urwid.LineBox(self.log_term)
|
self.widget = urwid.LineBox(self.log_term)
|
||||||
|
|
||||||
|
def kill(self):
|
||||||
|
if self.log_term != None:
|
||||||
|
self.log_term.terminate()
|
||||||
|
self.log_term = None
|
||||||
|
self.widget = None
|
||||||
|
|
||||||
def shortcuts(self):
|
def shortcuts(self):
|
||||||
return self.shortcuts_display
|
return self.shortcuts_display
|
||||||
|
|
||||||
@@ -26,10 +37,14 @@ class LogTerminal(urwid.WidgetWrap):
|
|||||||
self.log_term = urwid.Terminal(
|
self.log_term = urwid.Terminal(
|
||||||
("tail", "-fn50", self.app.logfilepath),
|
("tail", "-fn50", self.app.logfilepath),
|
||||||
encoding='utf-8',
|
encoding='utf-8',
|
||||||
escape_sequence="up"
|
escape_sequence="up",
|
||||||
|
main_loop=self.app.ui.loop,
|
||||||
)
|
)
|
||||||
urwid.WidgetWrap.__init__(self, self.log_term)
|
urwid.WidgetWrap.__init__(self, self.log_term)
|
||||||
|
|
||||||
|
def terminate(self):
|
||||||
|
self.log_term.terminate()
|
||||||
|
|
||||||
|
|
||||||
def keypress(self, size, key):
|
def keypress(self, size, key):
|
||||||
if key == "up":
|
if key == "up":
|
||||||
|
|||||||
@@ -116,6 +116,7 @@ class MainDisplay():
|
|||||||
|
|
||||||
def show_log(self, user_data):
|
def show_log(self, user_data):
|
||||||
self.sub_displays.active_display = self.sub_displays.log_display
|
self.sub_displays.active_display = self.sub_displays.log_display
|
||||||
|
self.sub_displays.log_display.show()
|
||||||
self.update_active_sub_display()
|
self.update_active_sub_display()
|
||||||
|
|
||||||
def show_guide(self, user_data):
|
def show_guide(self, user_data):
|
||||||
@@ -125,6 +126,8 @@ class MainDisplay():
|
|||||||
def update_active_sub_display(self):
|
def update_active_sub_display(self):
|
||||||
self.frame.contents["body"] = (self.sub_displays.active().widget, None)
|
self.frame.contents["body"] = (self.sub_displays.active().widget, None)
|
||||||
self.update_active_shortcuts()
|
self.update_active_shortcuts()
|
||||||
|
if self.sub_displays.active_display != self.sub_displays.log_display:
|
||||||
|
self.sub_displays.log_display.kill()
|
||||||
|
|
||||||
def update_active_shortcuts(self):
|
def update_active_shortcuts(self):
|
||||||
self.frame.contents["footer"] = (self.sub_displays.active().shortcuts().widget, None)
|
self.frame.contents["footer"] = (self.sub_displays.active().shortcuts().widget, None)
|
||||||
|
|||||||
6
nomadnet/vendor/Scrollable.py
vendored
6
nomadnet/vendor/Scrollable.py
vendored
@@ -268,10 +268,10 @@ class Scrollable(urwid.WidgetDecoration):
|
|||||||
def _get_original_widget_size(self, size):
|
def _get_original_widget_size(self, size):
|
||||||
ow = self._original_widget
|
ow = self._original_widget
|
||||||
sizing = ow.sizing()
|
sizing = ow.sizing()
|
||||||
if FIXED in sizing:
|
if FLOW in sizing:
|
||||||
return ()
|
|
||||||
elif FLOW in sizing:
|
|
||||||
return (size[0],)
|
return (size[0],)
|
||||||
|
elif FIXED in sizing:
|
||||||
|
return ()
|
||||||
|
|
||||||
def get_scrollpos(self, size=None, focus=False):
|
def get_scrollpos(self, size=None, focus=False):
|
||||||
"""Current scrolling position
|
"""Current scrolling position
|
||||||
|
|||||||
2
setup.py
2
setup.py
@@ -30,6 +30,6 @@ setuptools.setup(
|
|||||||
entry_points= {
|
entry_points= {
|
||||||
'console_scripts': ['nomadnet=nomadnet.nomadnet:main']
|
'console_scripts': ['nomadnet=nomadnet.nomadnet:main']
|
||||||
},
|
},
|
||||||
install_requires=["rns>=0.6.4", "lxmf>=0.3.8", "urwid==2.1.2", "qrcode"],
|
install_requires=["rns>=0.7.0", "lxmf>=0.3.9", "urwid>=2.4.2", "qrcode"],
|
||||||
python_requires=">=3.6",
|
python_requires=">=3.6",
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user