Getting started with the process.

master
josiah 3 years ago
parent 1a688bb214
commit 66487e0825

@ -0,0 +1,11 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
[dev-packages]
[requires]
python_version = "3.9"

@ -1,3 +1,32 @@
# MOLE
Matrix Orgmode ListenER.
Matrix Orgmode ListenER
## Project Summary
- Send your thoughts to a matrix channel! Its easy, its everywhere, and its plaintext.
- Convert individual messages in your matrix channel into todo items in orgmode
- Assumes the same sorts of things as other mobile orgmode solutions, a mobile-refile.org file, that sort of thing.
- Eventually, come back on your main computer and refile shit accordingly.
## Project Outline
- [ ] Be able to read and write orgmode from within Python (use Karlicoss' library for this)
- [ ] Be able to read and write matrix messages from within Python (use matrix nio, apparently its the Approved Shit now https://github.com/poljar/matrix-nio)
- [ ] Package using Pypi
- Eventually I'd like the option of deploying via ansible with the community playbooks, so also build out a Dockerfile.
- [ ] Add an ansible-playbook for deploying via matrix-docker-ansible-deploy, if they'll have me.
- [ ] Use all the same packages i'm floating for developer standards at work:
## Misc Project Thoughts
- My bot will have to be able to talk over HTTP, I guess.
- It'd be good if I could use pantalaimon for encryption, so messages can be sent E2E, then decrypted wherever the bot is to get added to the refile.
- Probably worth also writing some elisp that auto saves/closes the mobile-refile file if you haven't looked at it in a minute or two. Prevents weird overwrites.
# TODOs
- [ ] setup all of this stuff
- [ ] Black + commithooks; feel free to tweak line settings
- [ ] Mypy + commithooks
- [ ] Pylint / Flake8; feel free to tweak line settings
- [ ] Pipenv (bluh. I guess this is what work is using, so, fine.)
- [ ] Pytest + unittest.
- [X] Python versions with pyenv
- This is pretty easy, though its a very stupid curl | bash. Fuckers.
- Also some annoying prereqs that you need to be careful about; some Mac specific fuckery.