Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
121 lines (95 sloc) 4.43 KB

Contributing

magpie Mailing List

If you're interested in contributing, consider signing up for magpie's mailing list.

Thanks!

Thanks to:

  • erickr for fixing searching for notes w/unicode (#40) and helping with other unicode issues (#42).
  • matthewi for making the listen address more configurable (#37).
  • tony-o for beginning the auto-save feature (#20), fixing the .git search problem (#21), cleaning up the base template (#22), and adding ünicode support.
  • Erwyn for fixing the write/reload race condition (#15)
  • tomleo for fixing the home dir config bug (#10)
  • looper for adding the home directory config functionality (#5)

Bug Fixes / Minor Changes

magpie uses todo.md to track TODO items in its code. If you're looking to fix bugs, magpie's todo.md is a good place to start.

New Features

There are a few features that magpie could use to make it really great, and even better competition for Evernote.

Git Setup

In order to use magpie right now, you have to know enough about git to init the repo, and set the user name and email. It would be nice if magpie was smart enough to do this through the web application.

Note history

It should be possible to show the history of a note, and diff the changes between notes versions, something like how redmine handles it on file versions.

Web Scraper

Evernote has a Javascript bookmarklet that will scrape a webpage and add it as a note. If I was better with Javascript, I'd try to implement this myself.

OCR

Evernote's OCR is really good. I looked into Python projects that would allow me to do OCR in magpie, and I didn't find anything that seemed both feature complete and easy to use.

A good option might be to use tesseract, but that will require that as an external dependency, rather than some pure python-implementation.

Other document scrapers

It would be great if a user could upload docs of various types to magpie and have them scraped into plaintext. I've already added a rudimentary PDF scraper, and I started building functionality into magpie already that will handle viewing the plaintext version of a non-plaintext document, by looking at files with identical names, only the plaintext filename starts with a dot. For example:

file.pdf  <-- PDF
.file.pdf <-- scraped plaintext

In the above example, magpie will render the .file.pdf plaintext file when you click on file.pdf in the left-hand side notes menu.

OCR should be done on parts of the PDF which does not have text in it, such as image parts or scanned PDFs.

Utils Config Tool

The pdf scraper and the script for turning emails into notes are called magpie utils (and exist in the utils dir of the code base). Like the web application, the utils each have their own config file, all located in magpie/config. There is functionality in the application to edit its own config file, but not to edit the config files for any of the utils. It would be nice if that was added by someone.

Testing

Some rudimentary tests exist on travis-ci, but more tests are always better. Submitting pull requests will automatically trigger travis to run magpie's tests against your pull request.

Documentation

Hopefully this documentation is good enough to get people using magpie, but documentation can always be more thorough.