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

gbdtransformation/brands/emtm/schema

@@ -0,0 +1,314 @@
+/TradeMark
+__/AppealDetails
+____/Appeal
+______/AppealDate
+______/AppealEventDetails
+________/AppealEvent
+__________/AppealEventCode
+__________/AppealEventDate
+______/AppealIdentifier
+______/AppealProceedingLanguageCode
+______/AppellantDetails
+________/AppellantKey
+__________/Identifier
+______/CaseReferenceDetails
+________/CaseReference
+________/CaseReference[@caseReferenceKind=Cancellation]
+________/CaseReference[@caseReferenceKind=International Application]
+________/CaseReference[@caseReferenceKind=Mark Record]
+________/CaseReference[@caseReferenceKind=Trade Mark]
+______/RepresentativeDetails
+________/RepresentativeKey
+__________/Identifier
+______/RespondentDetails
+________/RespondentKey
+__________/Identifier
+______/RespondentRepresentativeDetails
+________/RespondentRepresentativeKey
+__________/Identifier
+__/ApplicantDetails
+____/Applicant
+______/ApplicantAddressBook
+________/ContactInformationDetails
+__________/URL
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressCity
+______________/AddressPostcode
+______________/AddressState
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/FirstName
+______________/LastName
+______________/LegalForm
+______________/MiddleName
+______________/OrganizationName
+________/PostalAddress
+______/ApplicantIdentifier
+______/ApplicantIncorporationCountryCode
+______/ApplicantIncorporationState
+______/ApplicantLegalEntity
+______/ApplicantNationalIdentification
+______/ApplicantNationalityCode
+____/Applicant[@operationCode=Delete]
+____/Applicant[@operationCode=Insert]
+__/ApplicationDate
+__/ApplicationLanguageCode
+__/ApplicationNumber
+__/CorrespondenceAddress
+____/CorrespondenceAddressIdentifier
+____/CorrespondenceAddressParty
+__/ExhibitionPriorityDetails
+____/ExhibitionPriority
+______/ExhibitionDate
+______/ExhibitionFirstDisplayDate
+______/ExhibitionName
+______/ExhibitionStatusCode
+__/ExpiryDate
+__/GoodsServicesDetails
+____/GoodsServices
+______/ClassDescriptionDetails
+________/ClassDescription
+__________/ClassNumber
+__________/GoodsServicesDescription
+__________/GoodsServicesDescription[@languageCode=en]
+__________/GoodsServicesDescription[@languageCode=es]
+__________/GoodsServicesDescription[@languageCode=fr]
+__/KindMark
+__/MarkCurrentStatusCode
+__/MarkCurrentStatusDate
+__/MarkDescriptionDetails
+____/MarkDescription
+____/MarkDescription[@languageCode=bg]
+____/MarkDescription[@languageCode=cs]
+____/MarkDescription[@languageCode=da]
+____/MarkDescription[@languageCode=de]
+____/MarkDescription[@languageCode=el]
+____/MarkDescription[@languageCode=en]
+____/MarkDescription[@languageCode=es]
+____/MarkDescription[@languageCode=et]
+____/MarkDescription[@languageCode=fi]
+____/MarkDescription[@languageCode=fr]
+____/MarkDescription[@languageCode=hr]
+____/MarkDescription[@languageCode=hu]
+____/MarkDescription[@languageCode=it]
+____/MarkDescription[@languageCode=lt]
+____/MarkDescription[@languageCode=lv]
+____/MarkDescription[@languageCode=mt]
+____/MarkDescription[@languageCode=nl]
+____/MarkDescription[@languageCode=pl]
+____/MarkDescription[@languageCode=pt]
+____/MarkDescription[@languageCode=ro]
+____/MarkDescription[@languageCode=sl]
+____/MarkDescription[@languageCode=sv]
+__/MarkDisclaimerDetails
+____/MarkDisclaimer
+____/MarkDisclaimer[@languageCode=bg]
+____/MarkDisclaimer[@languageCode=cs]
+____/MarkDisclaimer[@languageCode=da]
+____/MarkDisclaimer[@languageCode=de]
+____/MarkDisclaimer[@languageCode=el]
+____/MarkDisclaimer[@languageCode=en]
+____/MarkDisclaimer[@languageCode=es]
+____/MarkDisclaimer[@languageCode=fi]
+____/MarkDisclaimer[@languageCode=fr]
+____/MarkDisclaimer[@languageCode=hu]
+____/MarkDisclaimer[@languageCode=it]
+____/MarkDisclaimer[@languageCode=nl]
+____/MarkDisclaimer[@languageCode=pl]
+____/MarkDisclaimer[@languageCode=pt]
+____/MarkDisclaimer[@languageCode=sv]
+__/MarkFeature
+__/MarkImageDetails
+____/MarkImage
+______/MarkImageCategory
+________/CategoryCodeDetails
+__________/CategoryCode
+______/MarkImageColourClaimedText
+______/MarkImageColourClaimedText[@languageCode=bg]
+______/MarkImageColourClaimedText[@languageCode=cs]
+______/MarkImageColourClaimedText[@languageCode=da]
+______/MarkImageColourClaimedText[@languageCode=de]
+______/MarkImageColourClaimedText[@languageCode=el]
+______/MarkImageColourClaimedText[@languageCode=en]
+______/MarkImageColourClaimedText[@languageCode=es]
+______/MarkImageColourClaimedText[@languageCode=et]
+______/MarkImageColourClaimedText[@languageCode=fi]
+______/MarkImageColourClaimedText[@languageCode=fr]
+______/MarkImageColourClaimedText[@languageCode=hr]
+______/MarkImageColourClaimedText[@languageCode=hu]
+______/MarkImageColourClaimedText[@languageCode=it]
+______/MarkImageColourClaimedText[@languageCode=lt]
+______/MarkImageColourClaimedText[@languageCode=lv]
+______/MarkImageColourClaimedText[@languageCode=nl]
+______/MarkImageColourClaimedText[@languageCode=pl]
+______/MarkImageColourClaimedText[@languageCode=pt]
+______/MarkImageColourClaimedText[@languageCode=ro]
+______/MarkImageColourClaimedText[@languageCode=sk]
+______/MarkImageColourClaimedText[@languageCode=sl]
+______/MarkImageColourClaimedText[@languageCode=sv]
+______/MarkImageFileFormat
+______/MarkImageFilename
+__/MarkRecordDetails
+____/MarkRecord
+______/BasicRecord
+________/BasicRecordKind
+________/BeneficiaryDetails
+__________/BeneficiaryKey
+____________/Identifier
+________/BeneficiaryRepresentativeDetails
+__________/BeneficiaryRepresentativeKey
+____________/Identifier
+________/ClaimantDetails
+__________/ClaimantKey
+____________/Identifier
+________/RecordCurrentStatusCode
+________/RecordCurrentStatusDate
+________/RecordScope
+________/RepresentativeDetails
+__________/RepresentativeKey
+____________/Identifier
+__/MarkSoundDetails
+____/MarkSound
+______/MarkSoundFileFormat
+______/MarkSoundFilename
+__/MarkThreeDimensionalModelDetails
+____/MarkThreeDimensionalModel
+______/ThreeDimensionalModelCategory
+________/CategoryCodeDetails
+__________/CategoryCode
+______/ThreeDimensionalModelFileFormat
+______/ThreeDimensionalModelFilename
+__/MarkVideoDetails
+____/MarkVideo
+______/MarkVideoCategory
+________/CategoryCodeDetails
+__________/CategoryCode
+______/MarkVideoFileFormat
+______/MarkVideoFilename
+__/OppositionDetails
+____/Opposition
+______/AppealDetails
+________/Appeal
+__________/AppealDate
+__________/AppealEventDetails
+____________/AppealEvent
+______________/AppealEventCode
+______________/AppealEventDate
+__________/AppealIdentifier
+__________/AppealProceedingLanguageCode
+__________/AppellantDetails
+____________/AppellantKey
+______________/Identifier
+__________/CaseReferenceDetails
+____________/CaseReference
+____________/CaseReference[@caseReferenceKind=Opposition]
+__________/RepresentativeDetails
+____________/RepresentativeKey
+______________/Identifier
+__________/RespondentDetails
+____________/RespondentKey
+______________/Identifier
+__________/RespondentRepresentativeDetails
+____________/RespondentRepresentativeKey
+______________/Identifier
+______/EarlierMarkDetails
+________/EarlierMark
+__________/ApplicationDate
+__________/ApplicationNumber
+__________/DesignatedCountryDetails
+____________/DesignatedCountryCode
+__________/EarlierMarkCountryCode
+__________/MarkFeature
+__________/RegistrationDate
+__________/RegistrationNumber
+__________/WordMarkSpecification
+____________/MarkVerbalElementText
+______/OpponentDetails
+________/OpponentKey
+__________/Identifier
+______/OppositionDate
+______/OppositionGroundText
+______/OppositionIdentifier
+______/ProceedingLanguageCode
+______/RepresentativeDetails
+________/RepresentativeKey
+__________/Identifier
+__/PriorityDetails
+____/Priority
+______/PriorityCountryCode
+______/PriorityDate
+______/PriorityNumber
+______/PriorityPartialIndicator
+______/PriorityStatusCode
+__/PublicationDetails
+____/Publication
+______/PublicationDate
+______/PublicationIdentifier
+______/PublicationPage
+______/PublicationSection
+__/RegistrationDate
+__/RegistrationOfficeCode
+__/RepresentativeDetails
+____/Representative
+______/RepresentativeAddressBook
+________/ContactInformationDetails
+__________/Email
+__________/Fax
+__________/Phone
+__________/URL
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressCity
+______________/AddressPostcode
+______________/AddressState
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/FirstName
+______________/LastName
+______________/MiddleName
+______________/OrganizationName
+________/PostalAddress
+______/RepresentativeIdentifier
+______/RepresentativeIncorporationCountryCode
+______/RepresentativeIncorporationState
+______/RepresentativeLegalEntity
+______/RepresentativeNationalityCode
+______/RepresentativeTypeCode
+____/Representative[@operationCode=Delete]
+____/Representative[@operationCode=Insert]
+__/SecondLanguageCode
+__/SeniorityDetails
+____/Seniority
+______/InternationalTradeMarkIndicator
+______/SeniorityApplicationDate
+______/SeniorityApplicationNumber
+______/SeniorityCountryCode
+______/SeniorityFilingDate
+______/SeniorityPartialIndicator
+______/SeniorityRegistrationDate
+______/SeniorityRegistrationNumber
+______/SeniorityStatusCode
+__/TradeDistinctivenessIndicator
+__/TradeMarkRelationDetails
+____/TradeMarkRelation
+______/RelatedTradeMarkIdentifier
+______/TradeMarkIdentifier
+______/TradeMarkRelationKind
+__/TransformationPriorityDetails
+____/TransformationPriority
+______/CancellationDate
+______/PriorityDate
+______/RegistrationDate
+______/RegistrationNumber
+______/TransformationCountryCode
+__/WordMarkSpecification
+____/MarkVerbalElementText
+/TradeMark[@operationCode=Delete]
+/TradeMark[@operationCode=Insert]

gbdtransformation/brands/emtm/template.yml

@@ -0,0 +1,125 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set _space = " " %}
+{% set status = TradeMark | translate_status %}
+{% set st13 = TradeMark.ApplicationNumber | st13('EM') %}
+
+st13: {{ TradeMark.ApplicationNumber | st13('EM') }}
+gbdStatus: {{ status }}
+registrationOfficeCode: EM
+type: TRADEMARK
+
+{% if not status == 'Delete' %}
+kind: {{ TradeMark.KindMark | translate_kind }}
+markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+designatedCountries:
+  - {{ TradeMark.RegistrationOfficeCode }}
+applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationDate: {{ TradeMark.ApplicationDate | convertdate('%Y-%m-%d') }}
+registrationNumber: {{ TradeMark | get_registration_nb(TradeMark.MarkCurrentStatusCode)}}
+registrationDate: {{ TradeMark.RegistrationDate }}
+applicationLanguageCode: {{ TradeMark.ApplicationLanguageCode }}
+secondLanguageCode: {{ TradeMark.SecondLanguageCode }}
+expiryDate:  {{ TradeMark.ExpiryDate }}
+officeStatus: {{ TradeMark.MarkCurrentStatusCode }}
+terminationDate: {{ TradeMark.MarkCurrentStatusDate | get_termination(status) }}
+statusDate: {{ TradeMark.MarkCurrentStatusDate | convertdate('%Y-%m-%d') }}
+markDisclaimerDetails:
+  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(desc._languageCode, TradeMark.ApplicationLanguageCode) }}
+  {% endcall %}
+markDescriptionDetails:
+  {% call(desc) match('MarkDescriptionDetails.MarkDescription', TradeMark) %}
+  - text: {{ desc }}
+    languageCode: {{ desc | guess_language(desc._languageCode, TradeMark.ApplicationLanguageCode) }}
+  {% endcall %}
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(desc) match('WordMarkSpecification.MarkVerbalElementText', TradeMark) %}
+    - text: {{ desc | remove_cr }}
+      languageCode: {{ desc | guess_language(desc._languageCode, TradeMark.ApplicationLanguageCode) }}
+    {% endcall %}
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
+  - name: {{ img.MarkImageFilename }}
+    colourIndicator: {{ img.MarkImageColourClaimedText | get_true_or_false }}
+    colourClaimed:
+      {% call(desc) match('MarkImageColourClaimedText', img) %}
+      - text: {{ desc }}
+        languageCode: {{ desc | guess_language(desc._languageCode, TradeMark.ApplicationLanguageCode) }}
+      {% endcall %}
+    classification:
+      kind: Vienna
+      version: {{ ASK_THE_OFFICE }}
+      code:
+      {% call(code) match('MarkImageCategory.CategoryCodeDetails.CategoryCode', img) %}
+        - {{ code }}
+      {% endcall %}
+  {% endcall %}
+markSoundDetails:
+  {% call(sound) match('MarkSoundDetails.MarkSound', TradeMark) %}
+  - filename: {{ sound.MarkSoundFilename }}
+    fileformat: {{ sound.MarkSoundFileFormat }}
+  {% endcall %}
+markVideoDetails:
+  {% call(video) match('MarkVideoDetails.MarkVideo', TradeMark) %}
+  - filename: {{ video.MarkVideoFilename }}
+    fileformat: {{ video.MarkVideoFileFormat }}
+  {% endcall %}
+
+{% call(nc_gs) match('GoodsServicesDetails.GoodsServices', TradeMark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% call(nice) match('ClassDescriptionDetails.ClassDescription', nc_gs) %}
+    - code: {{ nice.ClassNumber | int }}
+      terms:
+      {% call(desc) match('GoodsServicesDescription', nice) %}
+        {{ desc | guess_language(desc._languageCode, TradeMark.ApplicationLanguageCode) | field_name }}:
+        {% for gsline in desc.__value | remove_trailing('.') | split_terms %}
+          - {{ gsline }}
+        {% endfor %}
+      {% endcall %}
+    {% endcall %}
+{% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+    - countryCode: {{ priority.PriorityCountryCode }}
+      number: {{ priority.PriorityNumber }}
+      date: {{ priority.PriorityDate }}
+      comment: {{ priority.PriorityStatusCode }}
+  {% endcall %}
+publications:
+  {% call(publication) match('PublicationDetails.Publication', TradeMark) %}
+    - identifier: {{ publication.PublicationIdentifier }}
+      date: {{ publication.PublicationDate }}
+      section: {{ publication.PublicationSection }}
+  {% endcall %}
+appeals:
+  {% call(apeal) match('AppealDetails.Appeal.AppealEventDetails.AppealEvent', TradeMark) %}
+  - kind: {{ apeal.AppealEventCode }}
+    date: {{ apeal.AppealEventDate }}
+  {% endcall %}
+applicants:
+  {% call(applicant) match('ApplicantDetails.ApplicantKey', TradeMark) %}
+  {% if not applicant._operationCode == 'Delete' %}
+  - {{ applicant.Identifier | get_entity_from_db(TradeMark.RegistrationOfficeCode, 'APP', st13) | field_name}}
+  {% endif %}
+  {% endcall %}
+
+representatives:
+  {% call(rep) match('RepresentativeDetails.RepresentativeKey', TradeMark) %}
+  {% if not representative._operationCode == 'Delete' %}
+  - {{ rep.Identifier | get_entity_from_db(TradeMark.RegistrationOfficeCode, 'REP', st13) | field_name}}
+  {% endif %}
+  {% endcall %}
+
+correspondence:
+  {% call(rep) match('CorrespondenceAddress', TradeMark) %}
+    {{ rep.CorrespondenceAddressIdentifier | get_entity_from_db('EM', rep.CorrespondenceAddressParty, st13) | field_name}}
+  {% endcall %}
+
+{% endif %}

gbdtransformation/brands/estm/__init__.py

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

gbdtransformation/brands/estm/filters.py

@@ -0,0 +1,110 @@
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://es.tmview.europa.eu/trademark/data',
+    'http://tmview.europa.eu/trademark/data'
+]
+
+def  get_entity_addr(addr):
+    if not addr: return None
+    return "%s %s %s" % (addr.AddressStreet, addr.AddressCity, addr.AddressPostcode)
+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_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind == 'Individual': return ['Individual']
+    if kind == 'Collective': return ['Collective']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    if not status: return 'Ended'
+
+    if status == 'Registered': return 'Registered'
+
+    if status in ['Application published',
+                  'Application filed',
+                  'Application opposed',
+                  'Appeal pending']:
+        return 'Pending'
+
+    return 'Unknown'
+    #raise Exception('Status "%s" unmapped' % status)
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+def translate_feature(feature):
+    """translation of mark feature"""
+
+    # needed information from office
+    # if office cannot provide information, then agree on a way to guess (uatm)
+    if not feature: return 'Undefined'
+    feature = feature.upper()
+    if feature == 'COMBINED': return 'Combined'
+    if feature == 'WORD': return 'Word'
+    if feature == 'STYLIZED_CHARACTERS': return 'Stylized characters'
+    if feature == 'FIGURATIVE': return 'Figurative'
+    if feature == 'SOUND': return 'Sound'
+    if feature == ' 3 d': return 'Three dimensional'
+    if feature == '3-d': return 'Three dimensional'
+    if feature == '_3_D': return 'Three dimensional'
+    if feature == '3-D': return 'Three dimensional'
+    return feature.lower().capitalize()
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    # default registration number to application number
+    # in case none is provided
+    if tmstatus in ['Registered', 'Expired']:
+        return trademark.ApplicationNumber
+
+# -----------------------
+# filtering empty tags
+# -----------------------
+def get_goods_services(goods_services):
+    nc_gs = {} # classified
+    if not goods_services:
+        goods_services = []
+
+    if not isinstance(goods_services, list):
+        goods_services = [goods_services]
+
+    for goods_service in goods_services:
+        code = goods_service.ClassNumber
+        if code and not code == '0':
+            nc_gs[code] = {}
+            desc = goods_service.GoodsServicesDescription
+
+            if hasattr(desc, '__value'):
+                terms = desc.__value
+            else:
+                terms = desc
+
+            if terms:
+                nc_gs[code]['terms'] = terms
+            else:
+                continue
+
+            if hasattr(desc, '_languageCode'):
+                lang = desc._languageCode
+                nc_gs[code]['lang'] = lang.lower()
+
+    return nc_gs

gbdtransformation/brands/estm/schema

@@ -0,0 +1,99 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkDetails
+__________/TradeMark
+____________/ApplicantDetails
+______________/Applicant
+________________/ApplicantAddressBook
+__________________/FormattedNameAddress
+____________________/Address
+______________________/AddressCountryCode
+______________________/FormattedAddress
+________________________/AddressCity
+________________________/AddressPostcode
+________________________/AddressStreet
+____________________/Name
+______________________/FormattedName
+________________________/FirstName
+________________________/LastName
+________________________/OrganizationName
+________________/ApplicantIdentifier
+______________/ApplicantKey
+________________/URI
+____________/ApplicationDate
+____________/ApplicationLanguageCode
+____________/ApplicationNumber
+____________/ExhibitionPriorityDetails
+______________/ExhibitionPriority
+________________/ExhibitionDate
+________________/ExhibitionName
+____________/GoodsServicesDetails
+______________/GoodsServices
+________________/ClassDescriptionDetails
+__________________/ClassDescription
+____________________/ClassNumber
+____________________/GoodsServicesDescription
+____________________/GoodsServicesDescription[@languageCode=es]
+____________/KindMark
+____________/MarkCurrentStatusCode
+____________/MarkCurrentStatusDate
+____________/MarkDescriptionDetails
+______________/MarkDescription
+____________/MarkDisclaimerDetails
+______________/MarkDisclaimer
+____________/MarkFeature
+____________/MarkImageDetails
+______________/MarkImage
+________________/MarkImageCategory
+__________________/CategoryCodeDetails
+____________________/CategoryCode
+________________/MarkImageColourClaimedText
+________________/MarkImageURI
+____________/PriorityDetails
+______________/Priority
+________________/PriorityCountryCode
+________________/PriorityDate
+________________/PriorityNumber
+________________/PriorityPartialGoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+____________/PublicationDetails
+______________/Publication
+________________/PublicationDate
+________________/PublicationSection
+____________/RegistrationDate
+____________/RegistrationNumber
+____________/RegistrationOfficeCode
+____________/RepresentativeDetails
+______________/Representative
+________________/RepresentativeAddressBook
+__________________/FormattedNameAddress
+____________________/Address
+______________________/AddressCountryCode
+______________________/FormattedAddress
+________________________/AddressCity
+________________________/AddressPostcode
+________________________/AddressStreet
+____________________/Name
+______________________/FormattedName
+________________________/FirstName
+________________________/LastName
+________________________/OrganizationName
+________________________/SecondLastName
+________________/RepresentativeIdentifier
+______________/RepresentativeKey
+________________/URI
+____________/SeniorityDetails
+______________/Seniority
+________________/SeniorityBeenClaimedNumber
+____________/WordMarkSpecification
+______________/MarkVerbalElementText
+______/TransactionIdentifier
+__/TransactionHeader
+____/SenderDetails
+______/RequestProducerDateTime