Skip to content

Dokument/walrus

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

EDIT

This project has essentially collapsed into https://github.com/Dokument/PyBitmessage-Daemon Everything that you could do with walrus, you can do with daemon exclusding passing arguments. It uses a cli instead.

I may come back and update this if it ever does not work with the current build, so it is worth keeping up with.

Thanks,

.dok

walrus

Walrus is a tool for sending images in PyBitmessage.

Roughly, it:

  • Base64 encodes the provided image
  • Wraps the image string in richtext markup
  • Sends the result as a message

To do those things it uses the API built into PyBitmessage

Bitmessage's Wiki explains how to configure your API credentials.

configuration

Walrus needs your API credentials. By default Walrus will attempt to load PyBitmessage's keys.dat from PyBitmessage's appdata folder. This should be fine for most users.

If you're running PyBitmessage in portable mode you'll need to set the path to the PyBitmessage folder. Use the bitmsgpath variable near the top of walrus.py to do so.

If you'd rather manually specify the username, password, host, and port, you can do so by setting the variables directly below bitmsgpath.

Walrus, by default, assumes you want to share images with the Image Board mailing list. The address is set below bitmsgpath. You can also specify an address to send to at runtime using the -t flag.

usage

Usage: walrus.py filename [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -s, --send            Send output to Address
  -f FROM, --from=FROM  Address/Label to send from
  -t TO, --to=TO        Address/Label to send to.
  -u SUBJECT, --subject=SUBJECT
                        Subject of the message. Default is image name.

Example of printing a base64 string of /home/user/image.png:

$ python walrus.py /home/user/image.png

todo

  • Get basic functionality implemented
  • Flesh out API portion and split into separate file
  • Support multiple images per message
  • Ensure To Address is valid
  • Make compatible with Python 3

help

Walrus has been tested on Ubuntu. It should work just as well on OSX and Windows but I can't be sure. Please open an issue if you've found an error in Walrus.

If you've found a problem with PyBitmessage, please open an issue on their Github issue tracker

contribute

I'd be happy to receive suggestions and pull requests here on Github.

license

Walrus is licensed under the MIT license. See the included LICENSE file or http://delicatebits.mit-license.org

About

A tool for sending images in BitMessage

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • Python 100.0%