Bootleg bot: Difference between revisions

From XPUB & Lens-Based wiki
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Networks==
''This page is prepared for the prototyping class on 3 March 2026 as part of SI29 and follows a Special Issue day with Doriane and Simon fully on topic of [[The bootleg library]].''


(we will go through the following commands from '''sergio''')
https://git.xpub.nl/kamo/bot-magic-words


To which networks is sergio connected right now?


ip a
==the zulip bot==


Is the bootleg library reachable? (see all HUB ip address [[HUB|here]])
First install the requirements listed on this page:


ping 10.0.0.103
https://zulip.com/help/writing-bots


Who else is on the network right now?
You can run the bot with:


  nmap 10.0.0.*
  zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py


And who else is on the eduroam (in the same subnet) right now?
(or <code>uv run zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py</code> if you are using uv)


nmap 145.24.152.*
===bootlegbot.py===


We can see this because we are part of these LAN networks.
<syntaxhighlight lang="python">
class BootlegBot(object):
    '''
    This is a small zulip bot to interact with the 👢🦵 library
    '''


(LAN = local area network)
    def usage(self):
        return '''Ask the bot about a book and they will search for it in the 👢🦵 library'''


But how do you travel from one network to another within the WAN?
    def handle_message(self, message, bot_handler):
        # This happens when someone write to the bot


(WAN = wider area network, aka the internet)
        sender = message['sender_full_name']
        content = message['content']
        print(f'{sender} wrote to the bot: "{content}"')


traceroute zulip.xpub.nl
handler_class = BootlegBot
</syntaxhighlight>


But how do we reach the hidden LAN/VPN 10.0.0.* network from the WAN?
===bootlegbot.zuliprc===


ssh tunnelling!
<pre>
[api]
email=bootleg-bot@zulip.xpub.nl
key=XXXXXXXX
site=https://zulip.xpub.nl
</pre>


==SSH tunnels==
We need to share the key with each other somehow.


https://ittavern.com/visual-guide-to-ssh-tunneling-and-port-forwarding/
===Zulip bot API===
 
https://zulip.com/help/interactive-bots-api
 
==hello Python!==
 
see: [[Hello Python]]
 
==SSH to bootleg library==
 
There are two ways in which we can do this.
 
===laptop > sergio > bootleg library (from outside the school)===
 
ssh sergio
sudo su - xpub
ssh pi@10.0.0.103
 
===laptop > bootleg library (on eduroam)===
ssh pi@145.24.153.55
 
==read database==
 
* Simon and Luke made this Python script in 2021, to make the temporary index cards: https://git.vvvvvvaria.org/simoon/temporary-indexing
* documentation of sqlite module in Python: https://docs.python.org/3/library/sqlite3.html
 
==write to database==
 
* a standalone webform for file uploads
* using the bootleg library upload URLs
* hosted on sergio (but can be hosted on another sandbox too in the future)
 
==See also==
 
* [[The bootleg library]] main documentation page of the bootleg library project
* https://cc.practices.tools/etherdot/bootleg-library/ graph based story of the bootleg library project
 
[[Category:Workbooks]]

Latest revision as of 11:20, 24 March 2026

This page is prepared for the prototyping class on 3 March 2026 as part of SI29 and follows a Special Issue day with Doriane and Simon fully on topic of The bootleg library.

https://git.xpub.nl/kamo/bot-magic-words


the zulip bot

First install the requirements listed on this page:

https://zulip.com/help/writing-bots

You can run the bot with:

zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py

(or uv run zulip-run-bot --config-file bootlegbot.zuliprc bootlegbot.py if you are using uv)

bootlegbot.py

class BootlegBot(object):
    '''
    This is a small zulip bot to interact with the 👢🦵 library
    '''

    def usage(self):
        return '''Ask the bot about a book and they will search for it in the 👢🦵 library'''

    def handle_message(self, message, bot_handler):
        # This happens when someone write to the bot

        sender = message['sender_full_name']
        content = message['content']
        print(f'{sender} wrote to the bot: "{content}"')

handler_class = BootlegBot

bootlegbot.zuliprc

[api]
email=bootleg-bot@zulip.xpub.nl
key=XXXXXXXX
site=https://zulip.xpub.nl

We need to share the key with each other somehow.

Zulip bot API

https://zulip.com/help/interactive-bots-api

hello Python!

see: Hello Python

SSH to bootleg library

There are two ways in which we can do this.

laptop > sergio > bootleg library (from outside the school)

ssh sergio
sudo su - xpub
ssh pi@10.0.0.103

laptop > bootleg library (on eduroam)

ssh pi@145.24.153.55

read database

write to database

  • a standalone webform for file uploads
  • using the bootleg library upload URLs
  • hosted on sergio (but can be hosted on another sandbox too in the future)

See also