{ "info": { "author": "Marcin Magnus", "author_email": "mag_dex@o2.pl", "bugtrack_url": null, "classifiers": [], "description": "# mmfinder\n\n updated Feb 2013\n version 0.98 alpha\n author Marcin Magnus (mag_dex@o2.pl) \n\t license GPLv3\n https://github.com/m4rx9/mmfinder\n\n--------------------------------------------------------------------------------\n\n\n\nSee http://www.youtube.com/watch?v=-oQ998IWwTc\n\nTABLE OF CONTENTS\n-----------------\n\n1. DESCRIPTION\n2. INSTALLATION\n3. CONFIGURATION\n4. HOW TO USE IT\n5. BUGS\n6. TODO\n7. COPYRIGHT AND LICENSE\n8. AUTHOR INFORMATION\n\n1. DESCRIPTION\n=======================================\n\n``mmfinder`` is a wrapper to *nix commands like ``locate``, ``updatedb``, ``grep``, ``find`` to help you with searching files across several machines (computers). \n\nFirstly, ``updatedb`` is used by ``mmfinder-deamon`` to create databases. You can define as many \"databases\" as you want in ``~/.mmfinder-config.py`` file.\n\nThe syntax is as follows:\n\n\tname_of_computer (you can name it as you want!) = {\n\t\t'name_of_database' : 'path_to_folder_for_database'\n\t}\n\n.. real-world working example ..\t\n\n computer1 = {\n 'dropbox' : '/home/magnus/Dropbox',\n 'debian' : '/home/magnus/',\n 'StoreJet': '/media/StoreJet',\n }\n\n.. for example, if I have the ``StoreJet`` connected to my computer and I run ``mmfinder-deamon``, a database ``StoreJet`` will be created that includes data from ``/media/StoreJet`` directory.\n\nNext, imagine that at work, you will never mount ``StoreJet``, but you want to create a database for your ``/home`` directory at work. You define another computer (for example, ``computer02 ``) as follows..\n\n computer2 = {\n 'dropbox' : '/home/magnus/Dropbox',\n 'maximus' : '/home/magnus/',\n 'truecrypt': '/media/truecrypt1/',\n }\n\nMy recommendation is to use Dropbox (https://www.dropbox.com/home) to put your config file there and make a link (`ln -s`) to your home directory and set the path to your databases like `~/Dropbox/opt/mmfinder/db`. You can share your settings and databases among many computer!\n\nYou can also use anything else (http://alternativeto.net/software/dropbox/) but then you need slightly change configuration file.\n\n## Bash plugin\n\nWhat is realy cool about ``mmfinder`` is that you can have pretty nice functionality if you add to your environment ``bash-plugin.sh``. You can g(o) to hit of result, r(un) it, e(emacs it = open in emacs), o(pen it).. see ``bash-plugin.sh``\n\n2. INSTALLATION\n=======================================\nTo install run:\n\n\tsudo pip install mmfinder\n\t# if you don't have `pip` -> sudo apt-get install python-pip\n\t\nor\n\n\tsudo python setup.py install\n\t\n3. CONFIGURATION\n=======================================\nGo to ``~/.mmfinder-config.py`` ..\n\nto use ``bash-plugin`` add .. \n\n\tcase $- in *i*) \n source /home/magnus/Dropbox/workspace/mmfinder/bash-plugin.sh\n\tesac\n\t\n.. to your ``.bashrc``\n\nFor ``mmfinder-deamon`` you might want to use ``cron`` as follows ..\n\n 00 * * * * /usr/local/bin/mmfinder-deamon\n\n4. HOW TO USE IT\n=======================================\nStart with configuration, then ``mmfinder.py -u`` or ``mmfinder_deamon.py`` and search ..\n\n mmfinder -g .bashrc # search for .bashrc across all defined machines\n\netc..\n\n5. BUGS\n=======================================\n\nReport bugs to the author.\n\t\n6. TODO\n=======================================\n\n- [ ] make a deb pkg\n- [ ] get old TODO from git repo with some TODOs :-)\n- [ ] check if all options works\n- [ ] write test script\n\n- [ ] how to promote the tool\n- [ ] add `tracker-search`\n- [ ] find similar tools and compare\n\n**BUGS**\n\n- [ ] problem with filenames with spaces\n- [ ] if a folder is found if you hit 'g' you will not get to the folder but to one folder up\n\n7. COPYRIGHT AND LICENCE\n=======================================\n\n mmfinder is Copyright (C) 2013 Marcin Magnus. All rights reserved.\n \n This program is free software; you can redistribute it and/or modify it\n under the same terms as GLP\n\n8. AUTHOR INFORMATION\n=======================================\n\nMarcin Magnus, mag_dex@o2.pl\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/m4rx9/mmfinder", "keywords": null, "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "mmfinder", "package_url": "https://pypi.org/project/mmfinder/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/mmfinder/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/m4rx9/mmfinder" }, "release_url": "https://pypi.org/project/mmfinder/0.98.alpha/", "requires_dist": null, "requires_python": null, "summary": "a tool for finding your files across different machines", "version": "0.98.alpha" }, "last_serial": 810159, "releases": { "0.98.alpha": [ { "comment_text": "", "digests": { "md5": "88ab73853e01f80758a6ca11a7835760", "sha256": "5fe335e0dcd749490fe489cfba9c0eff6d682c3cc8c2be345d2d137994545ff5" }, "downloads": -1, "filename": "mmfinder-0.98.alpha.tar.gz", "has_sig": false, "md5_digest": "88ab73853e01f80758a6ca11a7835760", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22581, "upload_time": "2013-03-26T00:35:56", "url": "https://files.pythonhosted.org/packages/94/15/d3b0b96a25d37bcb263d851cf92388e15988d1e7708f05eedc06a5ebe6cc/mmfinder-0.98.alpha.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "88ab73853e01f80758a6ca11a7835760", "sha256": "5fe335e0dcd749490fe489cfba9c0eff6d682c3cc8c2be345d2d137994545ff5" }, "downloads": -1, "filename": "mmfinder-0.98.alpha.tar.gz", "has_sig": false, "md5_digest": "88ab73853e01f80758a6ca11a7835760", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22581, "upload_time": "2013-03-26T00:35:56", "url": "https://files.pythonhosted.org/packages/94/15/d3b0b96a25d37bcb263d851cf92388e15988d1e7708f05eedc06a5ebe6cc/mmfinder-0.98.alpha.tar.gz" } ] }