• Stars
    star
    998
  • Rank 45,938 (Top 1.0 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created over 13 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

What did I do on February 14th 2007? Visualize your (digital) life in Org-mode

What were you doing on February 14th of 2007? On which tasks were you working on that very day you met your girl friend? When was the last appointments with your dentist? Who called you on telephone during that meeting with your customer last month?

Most people can not answer such questions. With Memacs you can!

Memacs extracts metadata (subjects, timestamps, contact information, …) from many different existing data sources (file names, emails, tweets, bookmarks, …) on your computer and generates files which are readable by GNU Emacs with Org mode.

Example:

   emails              -> memacs-maildir.py  \
   firefox history     -> memacs-firefox.py   |
   SMS                 -> memacs-sms.py       |
   RSS-feeds           -> memacs_rss.py       |
   bank statements     -> memacs-easybank.py  |>  Memacs
   postings            -> memacs-slrn.org     |
   git repository logs -> memacs_git.py       |
   svn repository logs -> memacs_svn.py      /
   |_________________|   |_________________|     |______|
   your personal data      Memacs modules        Org mode

Memacs - as the central component of the system - is a hub for all the connectors that add data from individual data sources. Those connectors are called Memacs modules or short module.

Your agenda automatically gets populated with entries similar to the example shown in the screenshot from the white paper:

https://github.com/novoid/screencasts/raw/master/memacs/2012-04-08_Memacs_2008-09-15_archive.png

You can see some demo data using the modulees for SMS, filenamedatestamps, Twitter, RSS, imap, phonecalls, and git.

Table of Contents

Installation

Install using Pip

The easiest way of installing Memacs is by using `pip`:

pip install memacs[all]

This gets you the whole set of modules with all dependencies on your system.

If you would like to define the dependencies more fine-grained, you can use one or more of the extras: gps, rss, ical, lastfm, battery, or twitter like the following example:

pip install memacs[gps,rss]

Manual Setup from Git

In case you prefer to set the environment β€œthe old way”, you can do it manually:

  • clone or download repository from github
  • make sure to use Python version 3
  • create a virtualenv or
  • export/set PYTHONPATH
PYTHONPATH=/path/to/memacs
  • install dependencies
pip install -r requirements.txt

Getting Started

The basic concept of using a Memacs module is following:

  1. Choose a Memacs module you want to use and set it up:
    • Read the module descripion files in the docs folder.
    • Each module shares global options but also comes with its very own set of custom arguments.
    • Manually start the module of your choice from the bin folder of Memacs with the argument --help, e.g. bin/memacs_csv.py --help in your command line in order to get an overview of the arguments of this module.
    • You probably want to develop and test a script (=.bat= or =.sh=) for the module invocation in the command line and …
  2. When this script works as expected, set up a periodical invocation so that your data gets converted to Org mode via Memacs regularily.
  3. For an update from a running instance of Emacs, independent of a recurrent schedule (e.g., Memacs’ photo module after returning from an excursion), you may add a key binding to Emacs, e.g. C-c m p to your configuration
       (defun mp-update-memacs-photos ()
         "An extra (i.e., not cron-scheduled) run of Memacs' photo module."
         (interactive)
    	 (shell-command
    	   (format "~/org/update-memacs-photos.sh")
    	 )
       )
    
       (global-set-key (kbd "C-c m p") 'mp-update-memacs-photos)
        

    The script called requires the provision of the executable bit. Additional background of this technique is compiled by Mickey Petersen in Mastering Key Bindings in Emacs.

  4. Think of another Memacs module you might want to try ;-)

Please make sure you also read the FAQ’s and best practices, as it contains many tips and tricks on how to meet your requirements and on how to choose a reasonable setup.

Workflows

Here are some workflows just to give you an initial impression how Memacs may give you much for digital fun.

The Basics

When one or more Memacs modules are set-up and data starts flowing in to your Memacs Org mode files, you have many options to use Memacs for your personal workflows.

The most basic thing that changes with Memacs is that you might want to see Memacs-processed data in your agenda:

Either you are generating (1) Org mode files that are within your agenda files or you are generating (2) archive files whose more or less empty Org mode file stub is within your agenda files (as described in the FAQs).

This way, the generated time-stamp information gets into your normal agenda (1) or in the extended in archives-mode (by pressing v A in your agenda) that also shows content of the archive files (2).

Filename Time-Stamp and Friends

A Memacs feature I personally use all the time provides a somewhat more complex workflow whose basic data is provided by the filename time-stamp module. The module indexes all my files that contain ISO-datestamps or ISO-timestamps in their file names just like updatedb does for β€œlocate”.

The fun starts, when this module is set-up and the file index is generated (nightly). With the elisp snippets mentioned in the module documentation, I am able to link to any of those files just by specifying their file name. This links never get broken since it does not matter in which folder files are located in any more.

Please refer to my Emacs configuration and look out for all occurrences of tsfile (time-stamp file) which is my custom link for those files.

I even extended this workflow such that my blog system is able to link to tsfile: images independent of their location. Awesome stuff.

Memacs Modules

This module is an example for developers: docs/memacs_csv.org

Those modules are not adopted to the new unified framework yet:

Following modules exist as a rough idea only and might get implemented some day (by you?):

Changelog

  • Version 2020.06.05.1
    • Features
    • Bugfixes
      • fix chrome.py output to include url and title for org headings
      • many improvements for the Chrome module
      • filenametimestamps: fixed check_datestamp_correctness (#97)
  • Version 2019.11.06.1
  • Versions prior to 2019-10-09.1 are not documented using this changelog. Please read the git commit messages.

Example Story

Imagine you are already using Memacs.

When remembering that day, when you joined an interesting talk about Β«Getting Things DoneΒ» (GTD), you start up your GNU Emacs with your main Org mode file. There you go to the Agenda-view and select this specific day a couple of months ago.

There it is, from 2pm to 3pm you scheduled this talk in your calendar. And then you realize that within this time frame, there appear some JPEG files containing an ISO 8601 time stamp[1] are indexed by one module. (filenametimestamp-module)

This image contains a slide you found interesting and which you photographed using your sleek smartphone. Who would remember having taken a picture during a talk?

Ten minutes after the talk you wrote a short message on Twitter where you mentioned useful URLs for your followers. This time those URLs are handy for yourself too! (Twitter-module)

On the evening of that day you see an entry of an incoming email from the author of the talk. Now you remember having had a cool conversation at the end of the talk where he promised you some additional information about that nice little GTD tool on his computer. Great that you got that link to that email too. Without Memacs you would probably never remembered that email again. (Maildir-module)

And then there were some bookmarks you saved this day, almost all related to great ideas you got from the GTD talk. (delicious-module)

This small story shows only a few use cases where different modules combine given data sources and their information to provide an overall view related to an event. Since Org mode has got links, no actual data has to be duplicated (except the meta data extracted by Memacs). Emails, files, bookmarks, and so forth are linked rather than copied.

[1] with periods instead of colons - just because the ancient limitations of Microsoft based file systems; like Β«2011-02-14T14.35.42 ideas.jpgΒ»

Background

In 1945, Vannevar Bush wrote a famous article Β«As We May ThinkΒ» where he develops the idea of having a Β«memory extenderΒ» called Memex. The memex can store all letters, books, and other information which are related to a person.

Besides having foreseen several technologies like hypertext, he defined a device that holds all metadata and data and provides associative trails to access information.

In the last decade of the previous century Microsoft Research had a research program that resulted in MyLifeBits. This software tried to store each information of the user like office documents, screenshots, name of active windows on the desktop computer, and even automatically took photographs (SenseCam). This word did not result in any (open) software product. Bell and Gemmell wrote a book called Β«Total RecallΒ».

The Memacs project tries to implement the ideas of Vannevar Bush’s vision with open source and open standards. Hence, it’s name Β«MemacsΒ» is the obvious combination of Β«GNU EmacsΒ» and Β«MemexΒ».

Memacs uses GNU Emacs Org mode to visualize and access information extracted by Memacs modules: using tags, time stamps, full text search, and so forth GNU Emacs is able to derive different views. The most important view probably is the Agenda-view where you can see anything that happened during a specific day/week/month according to the time frame selected. But you can derive other views too. For example you can choose to generate a condensed search result using a boolean combination of tags.

Related to Memacs, the project founder developed a research software called tagstore. This system allows users to store (local) files using tags without a hierarchy of folders. As a natural extension, tagstore targets associative access for (local) files. You might want to check out tagstore too. Memacs and tagstore are a very useful combination.

If you do like to know how to efficiently organize digital files in a simple and operating system independent way, read this blog post from Karl. It might give you ideas for your workflows as well.

Karl also wrote a whitepaper on Memacs which describes Memacs from a scientists point of view.

Similar Projects

Contribute! We are looking for your ideas:

If you want to contribute to this cool project, please fork and contribute or write an additional module!

See docs/FAQs_and_Best_Practices.org for more developing information.

We are sure that there are a lot of cool ideas for other modules out there! This is just the beginning!

Memacs is designed with respect to minimal effort for new modules.

We are using Python PEP8 and Test Driven Development (TDD).

License

Memacs is licensed under the GPLv3 license.

More Repositories

1

lazyblorg

Blogging with Org-mode for very lazy people
Python
376
star
2

filetags

Management of simple tags within file names
Python
199
star
3

LaTeX-KOMA-template

Generic template for midsize and larger documents based on KOMA script classes.
TeX
196
star
4

dot-emacs

My GNU/Emacs configuration
Emacs Lisp
177
star
5

org-mode-workshop

Workshop for Org-mode with focus on todo-, project- and workflow-management
161
star
6

github-orgmode-tests

This is a test project where you can explore how github interprets Org-mode files
146
star
7

date2name

Handling time-stamps and date-stamps in file names
Python
69
star
8

appendfilename

Intelligent appending text to file names, considering file extensions and file tags
Python
45
star
9

guess-filename.py

Derive a file name according to old file name cues and/or PDF file content
Python
39
star
10

extract_pdf_annotations_to_orgmode

Extracting RepliGo PDF annotations to a Org-mode format snippet (unmaintained!)
Shell
28
star
11

orgmode-ACM-template

Using new Emacs Org-mode LaTeX exporter to generate LaTeX/PDF files that meet the requirements of ACM (unmaintained!)
28
star
12

orgformat

Utility library for providing functions to generate and modify Org mode syntax elements like links, time-stamps, or date-stamps.
Python
27
star
13

tagstore

a research software; a fun way of storing files & folders on your local disk drive; tagging
Python
24
star
14

org-contacts2vcard

Converting Emacs Org-mode org-contacts contact information to VCard format suitable for importing to Android 4.4
Python
22
star
15

move2archive

Managing event-related files in a folder hierarchy like "<ARCHIVE>/2013/2013-05-17 Event name/"
Python
22
star
16

org-du

Visualizing Emacs Org-mode heading lines using du and xdu
Python
21
star
17

exchange2org

Connects to your Exchange server and extracts data in Org-mode format
Python
19
star
18

integratethis

Integrate programs or scripts into common tools like Windows Explorer context menu
Python
17
star
19

orgmode-iKNOW2012

Demonstrating the generation of an ACM paper using Emacs Org-mode and LaTeX export
Emacs Lisp
15
star
20

jira2org-story.py

Extract Jira Issues and Generate Org-mode Headings
Python
14
star
21

nixos-config

NixOS + flakes + home-manager with xfce, zsh, tmux, ...
Nix
13
star
22

twitter-json_to_orgmode

Converts the Twitter export files (JSON format) into an Emacs Org-mode file
Python
13
star
23

Student-Supervision-Process

How to organize supervision of the development of (LaTeX-) documents of students
12
star
24

title-capitalization.el

Proper English title capitalization of a marked region
Emacs Lisp
11
star
25

LaTeX-KOMA-VWA

Vorwissenschaftliche Arbeit (VWA) mit pdflatex/KOMA professionell gestalten
10
star
26

appendorgheading

Append a new Org mode heading to an existing Org mode file
Python
8
star
27

muttfilter.py

Per-contact FROM-email addresses for users of mutt and org-contacts.el
Python
7
star
28

convert_iCal_to_free-busy-only

Filter out things from an iCalendar file to publish free/busy information only
Python
7
star
29

filetagslib

Utility library for providing functions related to the filetags file name convention: https://github.com/novoid/filetags
Python
7
star
30

fetchphotos

A Python script to fetch data from a digital camera, rotating image files, renaming according to my file name convention.
Python
7
star
31

vkl

vkl - a better "ls"-experience
Python
6
star
32

recode-h107d-videos

Recode Hubsan x4 H107d video recordings in order to save space and correct the aspect ratio
Shell
6
star
33

orgmode-balance

Script that gives feedback on how you are doing in your Org-mode todos
Shell
6
star
34

getdigicamdata.sh

Fetching data from my digital camera, rotating image files, renaming according to my file name convention.
Shell
5
star
35

2011-01-tagstore-formal-experiment

Collected public data and tools concerning a formal experiment conducted with tagstore
Shell
4
star
36

postprocess_Org-mode_iCal_export

Adding reminder alarms (defined as Org-mode tags) to your iCalendar export file
Python
4
star
37

2011-04-tagstore-formal-experiment

Collected public data and tools concerning a formal experiment conducted with tagstore
Python
3
star
38

gettvthek

Downloads WMV files from ORF-TVthek
Shell
3
star
39

GenerateSeatingplan.py

Uses output-CSV files of CAMPUSonline containing students attending an exam and generates a randomized seating plan
Python
2
star
40

set_desktop_background_according_to_season

Sets the desktop backgrounds of OS X 10.5 according to photographs which are from a similar season
Python
2
star
41

LaTeX-CV-template

A bi-langual LaTeX template for CVs
TeX
2
star
42

org-mode-demodata

An Org mode file that contains data that should mimic normal day-to-day data
2
star
43

vkSenseCam

Download-script for Microsoft SenseCam or Vicon Revue v1
Python
1
star
44

orgdepend_to_orgedna

A Python script to convert Emacs Org mode files using org-depend to org-edna (dependency management)
Python
1
star
45

mediathekview_change_downloads_to_http

Modify pending MediathekView download URLs from https to http
Python
1
star
46

convert-OS-X-file-labels-to-filetags

This is a hack which searches and converts OS X 10.5 file labels to filetags
Shell
1
star
47

mailhours

Visualize the times of the day of emails sent by a certain person (maildir)
Shell
1
star