[Core]
Name = Plugin Name
Module = plugin_name

[Documentation]
Author = 
Version = 
Website = 
Description = 

from models.InputPlugin import InputPlugin

class PluginName(InputPlugin):
  
  name="plugin_name"
  '''
  플러그인 구성이 마법사를 호출해야 하는 경우
  (예: oAuth 인증) 이 값을 true로 설정해야 합니다.
  '''
  hasWizard=True
  
  def searchForTargets(self, search_term):
    '''
    Parameters
    ----------
    search_term : str
      사용자가 New Project 마법사에서 입력한 검색어입니다. 메일, ID,
      사용자 이름, 전체 이름일 수 있으며, 필요에 따라 서로 다른 유형을
      구분하는 것은 플러그인의 책임입니다.
      
      
    사용자로부터 문자열 매개변수를 받아 해당 서비스/소스에서 검색을 수행하여
    프로세스에 포함할 가능한 대상을 식별합니다.
    식별된 각 대상에 대해 하나씩 사전 목록을 반환하거나 결과가 없으면 빈 목록을 반환합니다.
    사전에는 다음 키가 포함되어야 합니다:
     target = {'pluginName':'Plugin Name',
               'targetUserid' : 'The userid of the target in the service/source',
               'targetUsername' : 'The username of the target in the service/source',
               'targetPicture' : 'the filename of the profile picture of the target ( profile_pic_targetUserid )',
               'targetFullname' : 'The full name of the target'}
               
    
    '''
    your_code_here()
    
    
    
    
  def runConfigWizard(self):
    '''
    플러그인 구성에 마법사가 필요한 경우 여기에 만드세요. 반환하기 전에 구성
    값을 플러그인의 구성 파일에 저장해야 합니다.
    플러그인 구성 파일에 대한 접근은 InputPlugin에서 상속된
    readConfiguration(category) 메서드를 통해 제공됩니다. 이 메서드는 튜플
    config, options를 반환합니다. 여기서
    -- config는 구성 저장에 사용할 수 있는 ConfigObj 파일로, write() 메서드를
    호출하여 저장할 수 있습니다.
    -- options는 구성 카테고리 옵션을 포함하는 사전입니다.
    
    '''
    
  def isConfigured(self):
  '''
  튜플을 반환합니다. 첫 번째 요소는 플러그인이 구성되었는지 여부에 따라 True 또는 False입니다. 두 번째
  요소에는 사용자를 위한 선택적 메시지가 포함됩니다.
  '''
  
  def returnLocations(self, target, search_params):
  '''
  Parameters
    ----------
    target : dict
    search_params : dict
    
  지정된 검색 매개변수를 사용하여 지정된 대상에 대한 위치 사전 목록(또는 위치를 찾지 못한 경우 빈 목록)을 반환합니다.
  target은 searchForTargets에 정의된 정보가 포함된 사전이며, search_params는
  구성 파일에서 사용 가능한 것으로 정의했을 검색 매개변수가 포함된 사전입니다
  (아래 plugin_name.conf 참조).
  위치 사전에는 다음 키가 포함되어야 합니다:
  
  loc = {'plugin' : 'twitter'
        'context' : 'Context of the location" 
        'infowindow' : "HTML with information in the location to be shown in the infoWindow on the map"
        'date' : 'a datetime.datetime object with information on when the gelocation was created' 
        'lat' : 'latitude of the location'
        'lon' : 'longitude of the location'
        'shortName' : 'short name describing the location, empty string if not available'}
        
      
  '''

[string_options]
key1 = value
[boolean_options]
key2 = True
key3 = False
[search_string_options]
key4 = some value
[search_boolean_options]
key5 = True

[labels]
key1 = Label For Key 1
key2 = Label For Key 2
key3 = Label For Key 3
key4 = Label For Key 4
key5 = Label For Key 5