You are here: sethdepot>SmartFMTools (2010-06-30, Main.RoLaUser)

smart.fm Tools

ALERT! smart.fm does terminate their support of the public API as of August 31, 2010. So this tool won't work anymore after this date ALERT!

http://smart.fm is a learning platform which was originally created to help you learning japanese vocabular. Nowadays is hosts nearly every kind of learning items. It's power comes from the user-contributed content of every kind.

smart.fm Bulk List Builder

Initial Revision from 2009

Usually to build your learning list, you use the smart.fm web interface and create item by item. That's easy for single entries, but very cumbersome for large number of vocabularies.
Fortunately smart.fm has an open API, which can be used for doing nearly everything possible. So also of course adding a lot of vocabularies in one rush.
That's what smart.fm Bulk List Builder does.

smart.fm Bulk List Builder is put under the GNU General Public License.

Download

You can download smart.fm Bulk List Builder from here.

Date Revision File Comment
2009 Initial smart.fm_bulk_add First public release

After downloading, please make the script executable:
chmod a+x smart.fm_bulk_add

Prerequisites

First of all perl itself is needed, but also some packages from CPAN.
The CPAN-Modules can be found at http://search.cpan.org

  • perl 5.8 or greater
  • CPAN LWP::UserAgent
  • CPAN HTTP::Request::Common
  • CPAN Text::CSV

Under debian LWP and HTTP are available from the package libwww-perl. Text::CSV comes from the package libtext-csv-perl

Program Usage

smart.fm_bulk_add [--help|-h] [--version|-V] add_to_list items_csv.csv

  • add_to_list: Add the newly created items to this numeric list
    (The number you can find from the URL, last number)
  • items_csv.csv: CSV file containing the items to add
  • --help|-h: Usage message
  • --version|-V: Program Version

Setup

To use smart.fm Bulk List Builder, do the following things

  1. Get an account with http://developer.smart.fm/ (same username as http://smart.fm)
  2. Apply for an API Key at http://developer.smart.fm/apps/register
  3. Add this data at the beginning of the program file below "Personal settings"
  4. To have at least some security, set this program for your eyes only
    Command: chmod og-a smart.fm_bulk_add

CSV File

The format of the input CSV file is straight forward. It's fields are:

  1. Comment marker; when this column isn't empty the whole line is ignored
  2. The content that needs to be memorized
  3. RFC 3066 language code for source language from 1
  4. Required part of speech (noun, phrase, verb etc)
    See http://developer.smart.fm/docs/Appendix/B_Parts_of_speech
  5. The translation of 1
  6. RFC 3066 language code for translation language from 4
  7. Kanji or Hanzi representing for 1 (optional)

Just see also
http://developer.smart.fm/docs/item_calls/create_item

Notes

This piece of software is still beta!
It's your own responsibility to make sure you won't kill your account or smart.fm :-)
A good idea would be to start with one item only when you're using it the first time.

If you have any questions or feedback, just send me a mail.

Topic revision: r2 - 2010-06-30 - 13:24:11 - Main.RoLaUser

Other Sites

 

This site is powered by Foswiki © by the contributing authors.
The content of this side is placed - when not noted otherwise - under a creative commons licensed under a Creative Commons license (Deutsch)