{"action":"created","issue":{"url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/6","repository_url":"https://api.github.com/repos/Jeanselme/Search_Engine","labels_url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/6/labels{/name}","comments_url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/6/comments","events_url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/6/events","html_url":"https://github.com/Jeanselme/Search_Engine/issues/6","id":187997917,"number":6,"title":"Arguments needed to make a research","user":{"login":"clinm","id":16208312,"avatar_url":"https://avatars.githubusercontent.com/u/16208312?v=3","gravatar_id":"","url":"https://api.github.com/users/clinm","html_url":"https://github.com/clinm","followers_url":"https://api.github.com/users/clinm/followers","following_url":"https://api.github.com/users/clinm/following{/other_user}","gists_url":"https://api.github.com/users/clinm/gists{/gist_id}","starred_url":"https://api.github.com/users/clinm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/clinm/subscriptions","organizations_url":"https://api.github.com/users/clinm/orgs","repos_url":"https://api.github.com/users/clinm/repos","events_url":"https://api.github.com/users/clinm/events{/privacy}","received_events_url":"https://api.github.com/users/clinm/received_events","type":"User","site_admin":false},"labels":[{"id":475339204,"url":"https://api.github.com/repos/Jeanselme/Search_Engine/labels/enhancement","name":"enhancement","color":"84b6eb","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2016-11-08T13:56:42Z","updated_at":"2016-11-08T22:08:10Z","closed_at":null,"body":"I would like to discuss the basic structure for the arguments of the search engine. From my point of view, we have two distinct functionalities : \r\n\r\n- Indexation (adding new document to the engine. No matter what kind of document it is (picture, subtitles etc)\r\n- Research (looking for specific entries added previously in the indexation phase)\r\n\r\n\r\nThe first idea that came to my mind to organize this is : \r\n\r\n- Entry point is *python Search.py*\r\n- Subpoint *python Search.py research*\r\n- Subpoint *python Search.py index*\r\n\r\nThe **research** and **index**  keyword can specify which functionality we want.\r\n\r\nOn the same principle, I think we could do the same for the **index** entry like following : \r\n```shell\r\n   python Search.py research <document_type> <query>\r\n```\r\n- document_type would be in [text, image, subtitle, ...]\r\n- query would fit the document_type requirement\r\n  - string for text\r\n  - path to image for image\r\n  - and so one\r\n\r\nExamples : \r\n```shell\r\n   python Search.py research text \"Alice\"\r\n   python Search.py research image ./path/to/my/image\r\n```\r\n\r\nI think this architecture would give us enough freedom to add as many endpoints as we want and should be pretty straightforward to implement using [argparse](https://docs.python.org/3/library/argparse.html)\r\n\r\n\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/comments/259274964","html_url":"https://github.com/Jeanselme/Search_Engine/issues/6#issuecomment-259274964","issue_url":"https://api.github.com/repos/Jeanselme/Search_Engine/issues/6","id":259274964,"user":{"login":"clinm","id":16208312,"avatar_url":"https://avatars.githubusercontent.com/u/16208312?v=3","gravatar_id":"","url":"https://api.github.com/users/clinm","html_url":"https://github.com/clinm","followers_url":"https://api.github.com/users/clinm/followers","following_url":"https://api.github.com/users/clinm/following{/other_user}","gists_url":"https://api.github.com/users/clinm/gists{/gist_id}","starred_url":"https://api.github.com/users/clinm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/clinm/subscriptions","organizations_url":"https://api.github.com/users/clinm/orgs","repos_url":"https://api.github.com/users/clinm/repos","events_url":"https://api.github.com/users/clinm/events{/privacy}","received_events_url":"https://api.github.com/users/clinm/received_events","type":"User","site_admin":false},"created_at":"2016-11-08T22:08:10Z","updated_at":"2016-11-08T22:08:10Z","body":"Assuming that we have a parameter for each kind of document we are handling. Are we taking into account all kind of composition between them ? I mean something like\r\n```shell\r\n  python3.5 SearchEngine.py research -text -image query\r\n```\r\nThen the arguments should look like that :\r\n```shell\r\n  python3.5 SearchEngine.py research [-text] [-image]\r\n  #instead of\r\n  python3.5 SearchEngine.py research [-text|-image]\r\n```\r\n\r\nIf we want to accelerate the command line (the type we take to type it), we should consider two different python scripts then : \r\n* SearchEngine.py\r\n* IndexEngine.py\r\n\r\nThen the normal use (and thus the most common command line) would be : \r\n```bash\r\n   python3.5 SearchEngine.py query\r\n```"}}
{"actor":{"display_login":"clinm"}}