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

gbdtransformation/brands/mwtm/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/mwtm/template.yml

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

gbdtransformation/brands/mxtm/__init__.py

@@ -0,0 +1,6 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+# 0319850061895
+appnum_mask = '\\d{2}\\d{4}(\\d*)'

gbdtransformation/brands/mxtm/filters.py

@@ -0,0 +1,77 @@
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://www.wipo.int/standards/XMLSchema/trademarks'
+]
+
+def  get_entity_addr(addr):
+    if not addr: return None
+    address = []
+
+    if addr.AddressStreet: address.append(addr.AddressStreet)
+    if addr.AddressCity: address.append(addr.AddressCity)
+    if addr.AddressPostcode: address.append(addr.AddressPostcode)
+
+    return ', '.join(address)
+
+def  get_entity_name(name):
+    if not name: return
+    if name.OrganizationName: return name.OrganizationName
+    return "%s %s" % (name.FirstName, name.LastName )
+
+def  get_entity_kind(name):
+    if not name: return
+
+    if name.OrganizationName: return 'Legal entity'
+    return 'Natural person'
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+def translate_type(type):
+    if type == 'Trade mark': return 'TRADEMARK'
+    if type == 'Slogan': return 'TRADEMARK'
+    if type == 'Title of establishment': return 'TRADEMARK'
+
+    raise Exception('type "%s" is not mapped.' % type)
+
+def translate_kind(kind, type):
+    if type == 'Trade mark':
+        if kind == 'Individual': return ['Individual']
+        if kind == 'Collective': return ['Collective']
+
+    if type == 'Slogan':
+        if kind == 'Individual': return ['Individual', type]
+        if kind == 'Collective': return ['Collective', type]
+
+    if type == 'Title of establishment': return ['Collective']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status, regnum):
+    if status == 'Active': return 'Registered'
+    if status == 'Pending': return 'Pending'
+    if status == 'Deleted':
+        if not regnum: return 'Ended'
+        else: return 'Expired'
+
+    raise Exception('Status "%s" unmapped' % status)
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature == 'Word': return 'Word'
+    if feature == 'Combined': return 'Combined'
+    if feature == 'Figurative': return 'Figurative'
+    if feature == '3-D': return 'Three dimensional'
+
+    raise Exception('Feature "%s" unmapped' % feature)
+
+def sanitize_text(text):
+    # for gs text
+    try: text = text.__value
+    except: pass
+
+    if text:
+        text = text.replace("
", " ").replace("
", " ").replace('\n', ' ')
+    return text

gbdtransformation/brands/mxtm/schema

@@ -0,0 +1,81 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkDetails
+__________/TradeMark
+____________/ApplicantDetails
+______________/Applicant
+________________/ApplicantAddressBook
+__________________/ContactInformationDetails
+____________________/Email
+____________________/Fax
+____________________/Phone
+__________________/FormattedNameAddress
+____________________/Address
+______________________/AddressCountryCode
+______________________/FormattedAddress
+________________________/AddressCity
+________________________/AddressPostcode
+________________________/AddressState
+________________________/AddressStreet
+____________________/Name
+______________________/FreeFormatName
+________________________/FreeFormatNameDetails
+__________________________/FreeFormatNameLine
+________________/ApplicantIncorporationCountryCode
+________________/ApplicantIncorporationState
+________________/ApplicantNationalityCode
+____________/ApplicationDate
+____________/ApplicationNumber
+____________/ExpiryDate
+____________/GoodsServicesDetails
+______________/GoodsServices
+________________/ClassDescriptionDetails
+__________________/ClassDescription
+____________________/ClassNumber
+____________________/GoodsServicesDescription
+____________________/GoodsServicesDescription[@languageCode=es]
+____________/IPRKind
+____________/KindMark
+____________/MarkCurrentStatusCode
+____________/MarkCurrentStatusDate
+____________/MarkDisclaimerDetails
+______________/MarkDisclaimer
+____________/MarkFeature
+____________/MarkImageDetails
+______________/MarkImage
+________________/MarkImageBinary
+________________/MarkImageCategory
+__________________/CategoryCodeDetails
+____________________/CategoryCode
+________________/MarkImageFileFormat
+____________/PriorityDetails
+______________/Priority
+________________/PriorityCountryCode
+________________/PriorityDate
+________________/PriorityNumber
+____________/RegistrationDate
+____________/RegistrationNumber
+____________/RegistrationOfficeCode
+____________/RepresentativeDetails
+______________/Representative
+________________/RepresentativeAddressBook
+__________________/ContactInformationDetails
+____________________/Email
+____________________/Fax
+____________________/Phone
+__________________/FormattedNameAddress
+____________________/Address
+______________________/FormattedAddress
+________________________/AddressCity
+________________________/AddressPostcode
+________________________/AddressStreet
+____________________/Name
+______________________/FreeFormatName
+________________________/FreeFormatNameDetails
+__________________________/FreeFormatNameLine
+____________/WordMarkSpecification
+______________/MarkVerbalElementText
+______/TransactionIdentifier

gbdtransformation/brands/mxtm/template.yml

@@ -0,0 +1,127 @@
+{% from 'navigation.tmpl' import match %}
+{% set TradeMark = Transaction.TradeMarkTransactionBody.TransactionContentDetails.TransactionData.TradeMarkDetails.TradeMark %}
+{% set status = TradeMark.MarkCurrentStatusCode | translate_status(TradeMark.RegistrationNumber) %}
+
+type: {{ TradeMark.IPRKind | translate_type }}
+kind: {{ TradeMark.KindMark | translate_kind(TradeMark.IPRKind) }}
+st13: {{ TradeMark.ApplicationNumber | st13('MX', appdate=TradeMark.ApplicationDate) }}
+gbdStatus: {{ status }}
+
+
+markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
+designatedCountries:
+  - {{ TradeMark.RegistrationOfficeCode }}
+
+applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationDate: {{ TradeMark.ApplicationDate | convertdate('%Y-%m-%d') }}
+registrationNumber: {{ TradeMark.RegistrationNumber }}
+registrationDate: {{ TradeMark.RegistrationDate }}
+applicationLanguageCode: 'es'
+
+officeStatus: {{ TradeMark.MarkCurrentStatusCode }}
+statusDate: {{ TradeMark.MarkCurrentStatusDate | convertdate('%Y-%m-%d') }}
+expiryDate: {{ TradeMark.ExpiryDate }}
+
+{% if status == 'Ended' %}
+terminationDate: {{ TradeMark.MarkCurrentStatusDate | convertdate('%Y-%m-%d') }}
+{% endif %}
+
+markDisclaimerDetails:
+  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ desc | sanitize_text }}
+    languageCode: {{ desc | sanitize_text | guess_language('es') }}
+  {% endcall %}
+
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(desc) match('WordMarkSpecification.MarkVerbalElementText', TradeMark) %}
+    - text: {{ desc }}
+      languageCode: {{ desc | guess_language('es') }}
+    {% endcall %}
+
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
+  - classification:
+      kind: Vienna
+      version: {{ ASK_THE_OFFICE }}
+      code:
+      {% call(code) match('MarkImageCategory.CategoryCodeDetails.CategoryCode', img) %}
+      - {{ code }}
+      {% endcall %}
+  {% endcall %}
+
+{% call(nc_gs) match('GoodsServicesDetails.GoodsServices', TradeMark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% call(nice) match('ClassDescriptionDetails', nc_gs) %}
+    - code: {{ nice.ClassDescription.ClassNumber | int }}
+      terms:
+      {% if nice.ClassDescription.GoodsServicesDescription | has_value %}
+      {% call(desc) match('ClassDescription.GoodsServicesDescription', nice) %}
+        es:
+        {% for gsline in desc | sanitize_text | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+      {% endcall %}
+      {% endif %}
+    {% endcall %}
+{% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+  - countryCode: {{ priority.PriorityCountryCode }}
+    number: {{ priority.PriorityNumber }}
+    date: {{ priority.PriorityDate }}
+  {% endcall %}
+
+applicants:
+  {% call(Applicant) match('ApplicantDetails.Applicant', TradeMark) %}
+  - identifier: {{ Applicant.ApplicantIdentifier }}
+    {% call(nameline) match('FormattedNameAddress.Name.FreeFormatName.FreeFormatNameDetails.FreeFormatNameLine', Applicant.ApplicantAddressBook) %}
+    fullName:
+      - text: {{ nameline }}
+        languageCode: {{ nameline | guess_language('es') }}
+    {% endcall %}
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FormattedAddress', Applicant.ApplicantAddressBook) %}
+      - text: {{ adrline | get_entity_addr}}
+        languageCode: {{ adrline | get_entity_addr | guess_language('es') }}
+      {% endcall %}
+    contact:
+      {% call(contactline) match('ContactInformationDetails', Applicant.ApplicantAddressBook) %}
+      phone: {{ contactline.Phone | remove_trailing('-') }}
+      email: {{ contactline.Email | remove_trailing('-') }}
+      fax: {{ contactline.Fax | remove_trailing('-') }}
+      {% endcall %}
+    {% call(adrline) match('FormattedNameAddress.Address', Applicant.ApplicantAddressBook) %}
+    countryCode: {{ Applicant.ApplicantNationalityCode }}
+    {% endcall %}
+  {% endcall %}
+  -
+representatives:
+  {% call(Representative) match('RepresentativeDetails.Representative', TradeMark) %}
+  {% if not Representative.RepresentativeIdentifier.endswith('-null') %}
+  - {% call(nameline) match('FormattedNameAddress.Name.FreeFormatName.FreeFormatNameDetails.FreeFormatNameLine', Representative.RepresentativeAddressBook) %}
+    fullName:
+      - text: {{ nameline }}
+        languageCode: {{ nameline | guess_language('es') }}
+      {% endcall %}
+    fullAddress:
+      {% call(adrline) match('FormattedNameAddress.Address.FormattedAddress', Representative.RepresentativeAddressBook) %}
+      - text: {{ adrline | get_entity_addr}}
+        languageCode: {{ adrline | get_entity_addr | guess_language('es') }}
+      {% endcall %}
+    contact:
+      {% call(contactline) match('ContactInformationDetails', Representative.RepresentativeAddressBook) %}
+      phone: {{ contactline.Phone | remove_trailing('-') }}
+      email: {{ contactline.Email | remove_trailing('-') }}
+      fax: {{ contactline.Fax | remove_trailing('-') }}
+      {% endcall %}
+    {% call(adrline) match('FormattedNameAddress.Address', Representative.RepresentativeAddressBook) %}
+    countryCode: MX
+    {% endcall %}
+  {% endif %}
+  {% endcall %}

gbdtransformation/brands/mytm/__init__.py

@@ -0,0 +1,17 @@
+render = 'JSON'
+source = 'national'
+
+# 2012051842
+# 08021824
+# 99001877
+# TM2019011877
+# M/031842
+# R/021842
+# MB061818
+# 83/01818
+appnum_mask = [ 'TM\\d{4}(\\d*)',
+                '([A-Z])/(\\d*)',
+                '\\d{4}0(\\d{5})',
+                '\\d{2}0(\\d{5})',
+                '(83)/(\\d*)',
+                '(.*)' ]

gbdtransformation/brands/mytm/filters.py

@@ -0,0 +1,125 @@
+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):
+    if appnum.startswith('TM'):
+        return appnum[2:6]
+
+    if appnum.find('/') > -1:
+        return appdate[:4]
+
+    if len(appnum) == 10:
+        return appnum[:4]
+
+    return '19%s' % (appnum[:2])
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'TRADE MARK': return 'TRADEMARK'
+    if code == 'CERTIFICATION': return 'TRADEMARK'
+    if code == 'DEFENSIVE': return 'TRADEMARK'
+    if code == 'COLLECTIVE MARK': return 'TRADEMARK'
+    if code == 'NOT DEFINED': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    kind = trademark.KindMark
+
+    if kind == 'TRADE MARK': return ['Individual']
+    if kind == 'CERTIFICATION': return ['Certificate']
+    if kind == 'DEFENSIVE': return ['Defensive']
+    if kind == 'COLLECTIVE MARK': return ['Collective']
+    if kind == 'NOT DEFINED': return ['Other']
+
+    raise Exception('Kind "%s" not mapped.' % kind)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    if status == '15': return 'Unknown'
+    if status == '17': return 'Unknown'
+    if status == '27': return 'Unknown'
+    if status == '28': return 'Unknown'
+    if status == '29': return 'Unknown'
+    if status == '30': return 'Unknown'
+    if status == '36': return 'Unknown'
+    if status == '86': return 'Unknown'
+    if status == '644': return 'Unknown'
+    if status == '645': return 'Unknown'
+    if status == '653': return 'Unknown'
+    if status == '671': return 'Unknown'
+    if status == '672': return 'Unknown'
+    if status == '688': return 'Unknown'
+    if status == '789': return 'Unknown'
+    if status == '791': return 'Unknown'
+    if status == '826': return 'Unknown'
+    if status == '448': return 'Unknown'
+    
+    if status == 'Suspended': 
+        return 'Ended'
+
+    if status == 'Inactive':
+        if trademark.ExpiryDate: 
+            return 'Expired'
+        else: 
+            return 'Ended'
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    if feature == 'WORD': return 'Word'
+    if feature == 'COMBINED': return 'Combined'
+    if feature == 'IMAGE': return 'Figurative'
+    if feature == 'COLOUR': return 'Colour'
+    if feature == 'STYLISH': return 'Stylized characters'
+    if feature == '3D': return 'Three dimensional'
+    if feature == 'SHAPE': return 'Three dimensional'
+    if feature == 'MOTION': return 'Motion'
+    if feature == 'POSITION': return 'Position'
+    if feature == 'SOUND': return 'Sound'
+    if feature == 'NOT DEFINED': return 'Undefined'
+    if feature == 'ANYCOMBINATION': return 'Undefined'
+    if feature == 'HOLOGRAM': return 'Hologram'
+    if feature == 'SMELL': return 'Olfactory'
+
+    raise Exception('Feature "%s" not mapped.' % feature)
+
+def translate_event(event):
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    # 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
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    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(header):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/mytm/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/mytm/template.yml

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