wipo-gbd-transformation 1.1.47__py3-none-any.whl → 1.1.59__py3-none-any.whl

gbdtransformation/brands/lktm/schema

@@ -0,0 +1,87 @@
+/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
+__________________/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/lktm/template.yml

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

gbdtransformation/brands/natm/__init__.py

@@ -6,7 +6,6 @@ source = 'national'
 # NA/T/197/593
 # AP/M/2006/413
 # A/D/1/825028
-appnum_mask = [ '[A-Z]{2}/([A-Z])/\\d{4}/(\\d*)',
-                '[A-Z]{2}/([A-Z])/\\d{3}/(\\d*)',
-                '([A-Z])/D/1/(\\d*)' ]
+appnum_mask = [ '([A-Z]{2})/([A-Z])/\\d*/(\\d*)',
+                '([A-Z])/[A-Z]/1/(\\d*)' ]
 

gbdtransformation/brands/natm/filters.py

@@ -11,27 +11,33 @@ def translate_type(header):
     code = header.TransactionCode
 
     # extraction missing info.
-    if code == 'Do Not Use':
+    if 'do not use' in code.lower():
         raise Exception('Code "%s" encountered. Skipping.' % code)
 
     if code == 'National Trademarks': return 'TRADEMARK'
+    if code == 'National Marks Act 2012': return 'TRADEMARK'
     if code == 'Madrid Marks': return 'TRADEMARK'
     if code == 'Banjul Trademark': return 'TRADEMARK'
+    if code == 'Banjul Protocol Marks': return 'TRADEMARK'
     if code == 'DEFENSIVE MARK': return 'TRADEMARK'
+    if code == 'CERTIFICATION MARK': return 'TRADEMARK'
 
     raise Exception('Type "%s" is not mapped.' % code)
 
 def translate_kind(trademark, header):
     subcode = header.TransactionSubCode
 
+    if subcode == 'Trade Mark': return ['Individual']
     if subcode == 'PART A': return ['Individual']
     if subcode == 'PART B': return ['Individual']
     if subcode == 'Banjul Trademark': return ['Individual']
+    if subcode == 'Banjul Protocol Marks': return ['Individual']
     if subcode == 'Madrid Protocol': return ['Individual']
     if subcode == 'Madrid Agreement': return ['Individual']
     if subcode == 'DEFENSIVE MARK': return ['Defensive']
+    if subcode == 'CERTIFICATION MARK': return ['Collective']
 
-    raise Exception('Kind "%s" not mapped.' % code)
+    raise Exception('Kind "%s" not mapped.' % subcode)
 
 def translate_status(trademark):
     status = trademark.MarkCurrentStatusCode

gbdtransformation/brands/notm/__init__.py

@@ -0,0 +1,5 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+

gbdtransformation/brands/notm/filters.py

@@ -0,0 +1,113 @@
+import re
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual mark': return ['Individual']
+    if kind == 'Collective mark': return ['Collective']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    if not status: return 'Ended'
+
+    if status in ['Registered',
+                  'Granted']: 
+        return 'Registered'
+
+    if status in ['Pending']:
+        return 'Pending'
+
+    if status in ['Refused',
+                  'Shelved',
+                  'Finally shelved',
+                  'Ceased',
+                  'Ceased/cancelled',
+                  'Withdrawn',
+                  'Rejected']:
+        return 'Ended'
+
+    return 'Unknown'
+    #raise Exception('Status "%s" unmapped' % status)
+
+def translate_feature(feature):
+    """translation of mark feature"""
+    if not feature: return 'Undefined'
+    feature = feature.upper()
+    if feature == 'COMBINED/FIGURATIVE MARK': return 'Combined'
+    if feature == 'FIGURATIVE MARK': return 'Figurative'
+    if feature == 'WORD MARK': return 'Word'
+    if feature == '3D-MARK': return "Three dimensional"
+    if feature == '3D MARK': return "Three dimensional"
+    if feature == 'SOUND MARK': return 'Sound'
+    if feature == 'COLOR MARK': return 'Colour'
+    if feature == 'MOTION MARK': return 'Motion'
+    if feature == 'MULTIMEDIA MARK': return 'Multimedia'
+    if feature == 'POSITION MARK': return 'Position'
+    if feature == 'PATTERN MARK': return 'Pattern'
+    if feature == 'HOLOGRAM MARK': return 'Hologram'
+    if feature == 'TRACER MARK': return 'Tracer'
+    if feature == 'OLFACTORY MARK': return 'Olfactory'
+    if feature == 'OLFACTIVE MARK': return 'Olfactory'
+    if feature == 'STYLIZED CHARACTERS': return 'Stylized characters'
+    if feature == 'STYLIZED CHARACTERS MARK': return 'Stylized characters'
+
+    return 'Unknown'
+
+    # raise Exception to recognize unmapped values
+    #raise Exception('Feature "%s" unmapped' % feature)
+
+def get_local_text(node):
+    if "$" in node:
+        return node["$"]
+
+def get_local_texts(nodes):
+    text = ""
+    start = True
+    for node in nodes:
+        if "$" in node:
+            if start:
+                start = False
+            else:
+                text += ", "
+            text += node["$"]
+    return text
+
+def get_full_address(postalStructuredAddress):
+    result = ""
+    if "addressLineText" in postalStructuredAddress:
+        for addressLineText in postalStructuredAddress["addressLineText"]:
+            # always empty, which is good
+            """
+            if hasattr(addressLineText, '__value'):
+                if len(result) > 0:
+                    result += ", "
+                result += addressLineText.__value
+            """
+    if "cityName" in postalStructuredAddress:
+        if len(result) > 0:
+            result += ", "
+        result += postalStructuredAddress["cityName"]
+    if "countryCode" in postalStructuredAddress:
+        result += ", " + postalStructuredAddress["countryCode"]
+    if "postalCode" in postalStructuredAddress:
+        result += " " + postalStructuredAddress["postalCode"]
+    if len(result) == 0:
+        return
+    else: 
+        return result.strip()
+
+def local_guess_language(content):
+    if content == None:
+        return None
+    from lingua import Language, LanguageDetectorBuilder
+    detector = LanguageDetectorBuilder.from_all_spoken_languages().build()
+    language = detector.detect_language_of(content)
+    if language:
+        lang = language.iso_code_639_1.name.lower()
+        # we merge Norwegian flavors, Norwegian Bokmål and Norwegian Nynorsk 
+        if lang == "nn" or lang =="nb":
+            lang = "no"
+        return lang
+    else:
+        return "en"

gbdtransformation/brands/notm/template.yml

@@ -0,0 +1,152 @@
+{% from 'navigation.tmpl' import match %}
+{% from 'navigation.tmpl' import enumerate %}
+
+{% call(trademark) match('trademark', trademarkBag) %}
+
+{% call(applicationNumber) match('applicationNumber', trademark.trademarkTypeChoice1) %}
+st13: {{ applicationNumber.applicationNumberText | st13('NO', appdate=trademark.trademarkTypeChoice2.applicationDate) }}
+applicationNumber: {{ applicationNumber.applicationNumberText }}
+{% endcall %}
+applicationDate: {{ trademark.trademarkTypeChoice2.applicationDate | convertdate('%Y-%m-%d') }}
+
+registrationNumber: {{ trademark.trademarkTypeChoice1.registrationNumber }}
+registrationDate: {{ trademark.registrationDate }}
+
+expiryDate: {{ trademark.expiryDate }}
+
+{% set status = trademark.markCurrentStatusCode | translate_status %}
+gbdStatus: {{ status }}
+officeStatus: {{ trademark.markCurrentStatusCode }}
+statusDate: {{ trademark.markCurrentStatusDate }}
+
+registrationOfficeCode: "NO"
+designatedCountries:
+  - "NO"
+
+type: TRADEMARK
+
+kind:
+  - Individual
+
+markFeature: {{ trademark.markFeatureDescription | translate_feature() }}
+# (Word|Stylized characters|Figurative|Combined|Three dimensional|Colour|Sound|Hologram|Olfactory|Motion|Municipal|Chimney|Other|Undefined)
+
+kind:
+  - Individual
+  # (Individual|Collective|Certificate|Defensive|Other|Membership)
+
+markDisclaimerDetails:
+  {% call(markDisclaimerText) match('markDisclaimerText', trademark.markDisclaimerBag) %}
+  - languageCode: 
+    text: {{ markDisclaimerText | get_local_text() }}
+  {% endcall %}
+
+markDescriptionDetails:
+  - languageCode:
+    text: 
+
+wordMarkSpecification:
+  markVerbalElement:
+    - languageCode:
+      text: {{ trademark.markRepresentation.markReproduction.wordMarkSpecification.markVerbalElementText | get_local_text() }}
+  markSignificantVerbalElement:
+    - languageCode:
+      text: {{ trademark.markRepresentation.markReproduction.wordMarkSpecification.markSignificantVerbalElementText | get_local_text() }}
+  markTranslation:
+    - languageCode:
+      text:
+  markTransliteration:
+
+markImageDetails:
+  {% call(markImage) match('markImage', trademark.markRepresentation.markReproduction.markImageBag) %}
+  - name: {{ markImage.fileName }}
+    colourIndicator: {{ markImage.colourModeCategory }}
+    colourClaimed:
+      - languageCode:
+        text:
+    description:
+      {% call(markDescriptionText) match('markDescriptionText', trademark.markRepresentation.markDescriptionBag.markDescriptionBagTypeChoiceSequence) %}
+      - languageCode:
+        text: {{ markDescriptionText | get_local_text() }}
+      {% endcall %}
+  {% endcall %}
+
+markSoundDetails:
+  - filename:
+    fileformat:
+
+markVideoDetails:
+  - filename:
+    fileformat:
+
+goodsServicesClassification:
+  kind: Nice 
+  version:
+  class:
+    {% call(goodsServices) match('goodsServices', trademark.goodsServicesBag) %}
+    {% call(classDescription) match('classDescription', goodsServices.classDescriptionBag) %}
+    - code: {{ classDescription.classNumber }}
+      terms:
+        {% call(goodsServicesDescriptionText) match('goodsServicesDescriptionText', classDescription) %}
+        {{ goodsServicesDescriptionText.localizedTextType | get_local_text | local_guess_language() }}:
+          - {{ goodsServicesDescriptionText.localizedTextType | get_local_text }}
+        {% endcall %}  
+    {% endcall %}
+    {% endcall %}
+
+priorities:
+  {% call(priority) match('priority', trademark.priorityBag) %}
+  - countryCode: {{  priority.priorityCountryCode }}
+    number: {{ priority.applicationNumber.applicationNumberText }}
+    date: {{ priority.priorityApplicationFilingDate }}
+    comment:
+  {% endcall %}
+
+publications:
+  - identifier:
+    date:
+    section:
+
+representatives:
+  {% call(representative) match('representative', trademark.representativeBag) %}
+  - identifier: {{ representative.partyIdentifier }}
+    kind:
+    fullName:
+      - languageCode:
+        text: {{ representative.contact.contactTypeChoiceSequence.name.entityName.transliterationName | get_local_texts() }}
+    fullAddress:
+      {% call(postalAddress) match('postalAddress', representative.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode:
+        text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
+      {% endcall %}
+    countryCode:
+  {% endcall %}
+
+correspondence:
+  fullName:
+    - languageCode:
+      text:
+  fullAddress:
+    - languageCode:
+      text:
+  countryCode:
+
+applicants:
+  {% call(applicant) match('applicant', trademark.applicantBag) %}
+  - identifier: {{ applicant.partyIdentifier }}
+    kind:
+    fullName:
+      - languageCode:
+        text: {{ applicant.contact.contactTypeChoiceSequence.name.entityName.transliterationName | get_local_texts() }}
+    fullAddress:
+      {% call(postalAddress) match('postalAddress', applicant.contact.contactTypeChoiceSequence.postalAddressBag) %}
+      - languageCode: 
+        text: {{ postalAddress.postalStructuredAddress | get_full_address() }}
+      {% endcall %}
+    countryCode: 
+  {% endcall %}
+
+{% endcall %}
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra:

gbdtransformation/brands/nztm/template.yml

@@ -10,9 +10,9 @@
 st13: {{ TradeMark.ApplicationNumber | st13(TradeMark.RegistrationOfficeCode, appdate=TradeMark.ApplicationDate) }}
 gbdStatus: {{ status }}
 registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
+type: TRADEMARK
 
 {% if not status == 'Delete' %}
-type: TRADEMARK
 kind: {{ TradeMark.KindMark | translate_kind(TradeMark.InternationalRegistrationNumber) }}
 
 markFeature: {{ TradeMark.MarkFeatureDetails.MarkFeature | translate_feature}}

gbdtransformation/brands/phtm/schema

@@ -1,50 +1,79 @@
-/RECORD
-__/AGENT
-____/ADDR_STREET
-____/AGENT_CODE
-____/CITY_NAME
-____/PERSON_NAME
-____/PROVINCE_NAME
-__/APPL_SUBTYP
-__/APPL_TYP
-__/APPNO
-__/EXPIRATION_DATE
-__/FILE_NBR
-__/FILE_SEQ
-__/FILE_SER
-__/FILE_TYP
-__/FILING_DATE
-__/LAW_CODE
-__/LOGO
-____/LOGO
-__/NICE_CLASS
-____/NICE_CLASS_CODE
-____/NICE_CLASS_DESCRIPTION
-__/OWNER
-____/ADDR_STREET
-____/CITY_NAME
-____/NATIONALITY_COUNTRY_CODE
-____/PERSON_NAME
-____/PROVINCE_NAME
-____/RESIDENCE_COUNTRY_CODE
-____/STATE_CODE
-____/STATE_NAME
-__/PRIORITIES
-____/COUNTRY_CODE
-____/PRIORITY_APPL_ID
-____/PRIORITY_DATE
-__/PUBLICATION_DATE
-__/REGISTRATION_DATE
-__/REGISTRATION_NBR
-__/SIGN_TYPE
-__/STATUS_CATEGORY
-__/STATUS_DATE
-__/STATUS_NAME
-__/TITLE
-__/VIENNA
-____/VIENNA_CLASS_CODE
-____/VIENNA_ELEM_CODE
-____/VIENNA_GROUP_CODE
-____/VIENNA_NAME
-____/VIENNA_TEXT
-__/sign_type
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventName
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+__________________/PublicationIdentifier
+__________________/PublicationSection
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/phtm/schema.classic

@@ -0,0 +1,50 @@
+/RECORD
+__/AGENT
+____/ADDR_STREET
+____/AGENT_CODE
+____/CITY_NAME
+____/PERSON_NAME
+____/PROVINCE_NAME
+__/APPL_SUBTYP
+__/APPL_TYP
+__/APPNO
+__/EXPIRATION_DATE
+__/FILE_NBR
+__/FILE_SEQ
+__/FILE_SER
+__/FILE_TYP
+__/FILING_DATE
+__/LAW_CODE
+__/LOGO
+____/LOGO
+__/NICE_CLASS
+____/NICE_CLASS_CODE
+____/NICE_CLASS_DESCRIPTION
+__/OWNER
+____/ADDR_STREET
+____/CITY_NAME
+____/NATIONALITY_COUNTRY_CODE
+____/PERSON_NAME
+____/PROVINCE_NAME
+____/RESIDENCE_COUNTRY_CODE
+____/STATE_CODE
+____/STATE_NAME
+__/PRIORITIES
+____/COUNTRY_CODE
+____/PRIORITY_APPL_ID
+____/PRIORITY_DATE
+__/PUBLICATION_DATE
+__/REGISTRATION_DATE
+__/REGISTRATION_NBR
+__/SIGN_TYPE
+__/STATUS_CATEGORY
+__/STATUS_DATE
+__/STATUS_NAME
+__/TITLE
+__/VIENNA
+____/VIENNA_CLASS_CODE
+____/VIENNA_ELEM_CODE
+____/VIENNA_GROUP_CODE
+____/VIENNA_NAME
+____/VIENNA_TEXT
+__/sign_type