wipo-gbd-transformation 1.1.105__py3-none-any.whl

gbdtransformation/brands/vctm/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/brands/vntm/__init__.py

@@ -0,0 +1,9 @@
+render = 'JSON'
+source = 'national'
+
+default_lang = 'vi'
+# 4201911818
+appnum_mask =  ['4-\\d{4}-(\\d*)',
+                '[A|B]-.*-\\d{4}-(\\d*)',
+                'MD-.*-\\d{4}-(\\d*)',
+                'VN-.*-\\d{4}-(\\d*)']

gbdtransformation/brands/vntm/filters.py

@@ -0,0 +1,84 @@
+import gbdtransformation.brands.ipas.filters as ipas
+from datetime import datetime
+
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/trademarks',
+   'http://www.wipo.int/standards/XMLSchema/wo-trademarks']
+
+def get_appdate(appdate, appnum):
+    try:
+        datetime.strptime(appdate, "%Y-%m-%d")
+        return appdate
+    except:
+        return appnum[5:9]
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'TradeMark': return 'TRADEMARK'
+
+    # sometimes they miss the header info
+    # but otherwise data is complete
+    return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    kind = trademark.KindMark
+    if not kind:
+        return 'Individual'
+    return ipas.translate_kind(kind)
+
+def translate_status(trademark):
+    value = trademark.MarkCurrentStatusCode
+    if value in ['Cấp bằng']:
+        return ipas.translate_status('Registered')
+    if value in ['Đang giải quyết']:
+        return ipas.translate_status('Pending')
+    elif value in ['Công bố']:
+        return ipas.translate_status('Pending')
+    elif value in ['Hết hạn', 'Rút đơn']:
+        return ipas.translate_status("Expired")
+    elif value in ['Từ chối', 'Từ bỏ', 'Mất hiệu lực']:
+        return ipas.translate_status('Ended')
+    return 'Unknown'
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    if event == 'Notificationd': return 'Notification'
+    if not event:
+        return None
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+# TODO: all set to vi but some are english really
+# TODO: {'vi': ['NITRASA, hình']} (remove the hih)
+def verbal_lang_map(markVerbalElements, applang='vi'):
+    # print( ipas.verbal_lang_map(markVerbalElements, applang=applang))
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    return None
+
+def get_expiry_date(trademark, tmstatus):
+    return ipas.get_expiry_date(trademark, tmstatus)
+
+def get_registration_date(trademark, tmstatus):
+    return ipas.get_registration_date(trademark, tmstatus)
+
+def is_international(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/vntm/schema

@@ -0,0 +1,86 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/KindMark
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventCode
+__________________/OfficeSpecificMarkEventDescription
+__________________/OfficeSpecificMarkEventDescription[@languageCode=en]
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageColourClaimedText
+__________________/MarkImageColourClaimedText[@languageCode=en]
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/vntm/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/brands/vutm/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# 1977/424
+appnum_mask = '\\d{4}/(\\d*)'

gbdtransformation/brands/vutm/filters.py

@@ -0,0 +1,67 @@
+import gbdtransformation.brands.ipas.filters as ipas
+
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/trademarks',
+   'http://www.wipo.int/standards/XMLSchema/wo-trademarks']
+
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[0]
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'Trademark': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    kind = trademark.KindMark
+
+    if kind == 'Individual': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % kind)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    if not feature: return 'Undefined'
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # 2227 => 2227
+    return trademark.ApplicationNumber
+
+def get_expiry_date(trademark, tmstatus):
+    return ipas.get_expiry_date(trademark, tmstatus)
+
+def get_registration_date(trademark, tmstatus):
+    return ipas.get_registration_date(trademark, tmstatus)
+
+def is_international(content):
+    return False
+
+def get_ir_refnum(appnum):
+    return appnum
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/vutm/schema

@@ -0,0 +1,83 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/KindMark
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventCode
+__________________/OfficeSpecificMarkEventDescription
+__________________/OfficeSpecificMarkEventDescription[@languageCode=en]
+__________________/OfficeSpecificMarkEventName
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageColourClaimedText
+__________________/MarkImageColourClaimedText[@languageCode=en]
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+__________________/PublicationIdentifier
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/vutm/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/brands/whoinn/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'international'
+
+appnum_mask = [ '.*(R\\d*).*(P\\d*).*' ]
+regnum_mask = [ '.*(R\\d*).*(P\\d*).*' ]

gbdtransformation/brands/whoinn/filters.py

@@ -0,0 +1,46 @@
+ignore_namespace = []
+
+def translate_status(status):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    if not status: return 'Unknown'
+
+    if status == 'Recommended':
+        return "Registered"
+    else:
+        return 'Pending'
+
+
+def get_appnum(inn):
+    appnum = ''
+    if inn.get('recommended'):
+        appnum += 'R' + inn.get('recommended').get('__value') + 'E' + inn.get('recommended').get('_entry')
+    if inn.get('proposed'):
+        appnum += 'P' + inn.get('proposed').get('__value') + 'E' + inn.get('proposed').get('_entry')
+    return appnum
+
+
+def get_status(inn):
+    status = 'Proposed'
+    if inn.get('recommended'):
+        status = 'Recommended'
+    return status
+
+def get_languages(inn):
+    to_return = []
+    if not  inn.get('transliteration', None):
+        return to_return
+    for el in sorted(inn['transliteration'].keys()):
+        if not inn['transliteration'][el]:
+            continue
+        to_return.append({
+            'lang': el,
+            'value': inn['transliteration'][el]
+        })
+    return to_return
+
+
+def get_st13_INN(appnum):
+    # QO: Organization without st13 code
+    return 'QO82%s' % (appnum.zfill(13))

gbdtransformation/brands/whoinn/schema

@@ -0,0 +1,4 @@
+# generate this file using
+$ gbd-transform-xpath /data/brands/collections/totm -o gbdtransformation/brands/totm/schema
+
+This process runs with a speed of 1000/sec

gbdtransformation/brands/whoinn/template.yml

@@ -0,0 +1,45 @@
+{% from 'navigation.tmpl' import match %}
+{% set appnum = inn | get_appnum  %}
+{% set status = inn | get_status  %}
+
+type: INN
+
+markFeature: Word
+registrationOfficeCode: WHO
+designatedCountries:
+  - XX
+
+applicationNumber: {{ appnum }}
+
+{% if status == 'Recommended' %}
+registrationNumber: {{ appnum }}
+{% endif %}
+
+st13: {{ appnum | get_st13_INN }}
+officeStatus: {{ status }}
+gbdStatus: {{ status | translate_status }}
+
+wordMarkSpecification:
+  markVerbalElement:
+    {% for el in inn | get_languages %}
+    - languageCode: {{ el.lang }}
+      text: {{ el.value }}
+    {% endfor %}
+
+representatives:
+  - fullName:
+      - languageCode: en
+        text: World Health Organization (WHO)
+    fullAddress:
+      - languageCode: en
+        text: Av. Appia 20, 1202 Genève
+    countryCode: CH
+
+extra:
+  code: {{ inn.code }}
+  recommended:
+    value: {{ inn.recommended.__value }}
+    entry: {{ inn.recommended._entry }}
+  proposed:
+    value: {{ inn.proposed.__value }}
+    entry: {{ inn.proposed._entry }}

gbdtransformation/brands/wo6ter/__init__.py

@@ -0,0 +1 @@
+render = 'JSON'

gbdtransformation/brands/wo6ter/filters.py

@@ -0,0 +1,88 @@
+from gbdtransformation.common import countries
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+def get_feature(doc):
+    has_word = doc['PROTECTED_SIGN'].get('TEXT', None) is not None
+    has_image = doc['PROTECTED_SIGN'].get('IMAGE', None) is not None
+
+    if has_word and has_image: return 'Combined'
+    if has_image: return 'Figurative'
+    if has_word: return 'Word'
+
+    raise Exception('Undetected feature')
+
+def translate_kind(kind):
+    if kind.lower().replace('_', ' ') == 'armorial bearings': return 'Armorial bearings'
+    if kind.lower().replace('_', ' ') == 'flag': return 'Flag'
+    if kind.lower().replace('_', ' ') == 'state emblem': return 'State emblem'
+    if kind.lower().replace('_', ' ') == 'emblem': return 'Emblem'
+    if kind.lower().replace('_', ' ') == 'official sign': return 'Official sign'
+    if kind.lower().replace('_', ' ') == 'abbreviation': return 'Abbreviation'
+    if kind.lower().replace('_', ' ') == 'name': return 'Name'
+
+    raise Exception('kind "%s" is not mapped.' % kind.lower().replace('_', ' '))
+
+def get_coutry_name(code):
+    country_name = countries.get(code, None)
+    if not country_name:
+        raise Exception('Country code %s not mapped' % state)
+    if isinstance(country_name, list):
+        country_name = country_name[0]
+    return country_name
+
+def get_status_and_date(sixter):
+    status = "Registered"
+    gbd_status = "Registered"
+    status_date = None
+    if sixter.STATUS:
+        status = sixter.STATUS.TEXT.lower().capitalize()
+        if status == 'Withdrawn':
+            gbd_status = 'Ended'
+        else:
+            raise Exception('Status %s not mapped' % status)
+
+        data = sixter.STATUS.DATE
+        if data:
+            status_date = "%s-%s-%s" % (data[0:4], data[4:6], data[6:])
+    return status, gbd_status, status_date
+
+def st13_sixter(sixter):
+    # remove special characters
+    appdate = sixter['_DATE']
+    appnum = sixter['_NUMBER']
+    if not appnum:
+        raise Exception("No appnumber provided")
+    if not appdate:
+        appdate = '0000'
+    office = sixter.STATE_ORG or 'WO'
+    return 'WO80%s%s%s' % (appdate[:4], office.upper(), appnum.zfill(7))
+
+def get_addr(addr):
+    vals = [addr.ADDRESS, addr.CITY, addr.ZIP]
+    vals = [ v for v in vals if v ]
+    return ', '.join(vals)
+
+def sanitize_text(text):
+    try: text = text.__value
+    except: pass
+
+    if text:
+        text = text.replace('"', '')
+    return text
+
+def split_vienna(data):
+   return '%s.%s.%s' % (data[0:2], data[2:4], data[4:])
+
+def reg_number(sixter):
+    # remove special characters
+    appnum = sixter.get('_NUMBER', '0')
+    office = sixter.STATE_ORG or 'QO'
+    return '%s%s' % (office.upper(), appnum)
+
+def to_link(value):
+    if value:
+        return 'https://6ter.wipo.int/pdf/en/e' + value + '.pdf'
+    return None

gbdtransformation/brands/wo6ter/template.yml

@@ -0,0 +1,88 @@
+{% from 'navigation.tmpl' import match %}
+{% set status, gbd_status, status_date = DATABASE.SIXTER | get_status_and_date %}
+type: EMBLEM
+kind:
+  - {{DATABASE.SIXTER.NATURE.TYPE | translate_kind}}
+gbdStatus: {{ gbd_status }}
+officeStatus: {{ status }}
+statusDate: {{ status_date }}
+
+markFeature: {{ DATABASE.SIXTER | get_feature }}
+
+registrationOfficeCode: SIXTER
+designatedCountries:
+  - XX
+
+reference:
+  office: {{ DATABASE.SIXTER.STATE_ORG }}
+
+st13: {{ DATABASE.SIXTER | st13_sixter }}
+
+registrationNumber: {{ DATABASE.SIXTER | reg_number }}
+registrationDate: {{ DATABASE.SIXTER._DATE | convertdate('%Y%m%d') }}
+
+{% call(sign) match('PROTECTED_SIGN', DATABASE.SIXTER) %}
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(text) match('TEXT', sign) %}
+    - text: {{ text }}
+      languageCode: {{ (sign._LANG or 'EN') | lower }}
+    {% endcall %}
+{% endcall %}
+
+markDesriptionDetails:
+  {% call(desc) match('DETAILSGR.DETAIL', DATABASE.SIXTER) %}
+  - text: {{ desc.TEXT }}
+    languageCode: {{ desc.TEXT._LANG | lower }}
+  {% endcall %}
+
+markImageDetails:
+  - name: {{DATABASE.SIXTER.PROTECTED_SIGN.IMAGE }}
+    {% if DATABASE.SIXTER.VIENNA %}
+    classification:
+      kind: Vienna #mostly
+      version: 7 #mostly
+      code:
+      {% call(desc) match('VIENNA.VIECLA', DATABASE.SIXTER) %}
+        - {{ desc | split_vienna }}
+      {% endcall %}
+    {% endif %}
+
+goodsServicesUnclassified:
+{% call(unclassified) match('NATURE.GOODSGR.GOODS', DATABASE.SIXTER) %}
+  - {{ unclassified._LANG | lower |  field_name }}:
+    - {{ unclassified | sanitize_text | split_terms }}
+{% endcall %}
+
+{% if DATABASE.SIXTER.ORGANIZATION %}
+applicants:
+  {% call(Applicant) match('ORGANIZATION', DATABASE.SIXTER) %}
+  - fullName:
+    {% call(nameline) match('NAME', Applicant) %}
+    - text: {{ nameline.__value}}
+      languageCode: {{ nameline._LANG | lower }}
+    {% endcall %}
+    {% if Applicant.ADDRESS %}
+    fullAddress:
+      - text: {{ Applicant | get_addr }}
+        languageCode: en
+    {% endif %}
+    countryCode: {{ Applicant.COUNTRY | upper }}
+  {% endcall %}
+{% else %}
+applicants:
+  - countryCode: {{ DATABASE.SIXTER.STATE_ORG | upper }}
+{% endif %}
+
+extra:
+  objections:
+    {% call(obj) match('OBJECTIONSGR.OBJECTIONS', DATABASE.SIXTER) %}
+    - countryCode: {{ obj.STATE }}
+      date: {{ obj.DATE | convertdate('%Y%m%d') }}
+    {% endcall %}
+  circulars:
+    {% call(obj) match('CIRCULAR', DATABASE.SIXTER) %}
+    - number: {{obj.NUMBER}}
+      pdf: {{ obj.NUMBER | to_link }}
+      date: {{ obj.DATE | convertdate('%Y%m%d') }}
+    {% endcall %}

gbdtransformation/brands/woao/__init__.py

@@ -0,0 +1 @@
+render = 'JSON'