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

gbdtransformation/brands/frtm/schema

@@ -0,0 +1,300 @@
+TradeMark[@operationCode=Insert]
+TradeMark[@operationCode=Update]
+TradeMark
+__/ApplicantDetails
+____/Applicant
+______/ApplicantAddressBook
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressBuilding
+______________/AddressCity
+______________/AddressPostOfficeBox
+______________/AddressPostcode
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/IndividualIdentifier
+______________/LastName
+______________/OrganizationName
+______/ApplicantIdentifier
+______/ApplicantIdentifier[@identifierKindCode=BE]
+______/ApplicantIdentifier[@identifierKindCode=CH]
+______/ApplicantIdentifier[@identifierKindCode=CL]
+______/ApplicantIdentifier[@identifierKindCode=CN]
+______/ApplicantIdentifier[@identifierKindCode=CW]
+______/ApplicantIdentifier[@identifierKindCode=FR]
+______/ApplicantIdentifier[@identifierKindCode=GB]
+______/ApplicantIdentifier[@identifierKindCode=LU]
+______/ApplicantIdentifier[@identifierKindCode=NL]
+______/ApplicantIdentifier[@identifierKindCode=PT]
+______/ApplicantIdentifier[@identifierKindCode=SE]
+______/ApplicantIdentifier[@identifierKindCode=SG]
+______/ApplicantLegalEntity
+______/ApplicantSequenceNumber
+______/Comment
+__/ApplicationDate
+__/ApplicationLanguageCode
+__/ApplicationNumber
+__/AssociatedMarkDetails
+____/AssociatedApplicationNumber
+__/Comment
+__/DivisionalApplicationDetails
+____/InitialApplicationDate
+____/InitialApplicationNumber
+__/ExpiryDate
+__/FilingPlace
+__/GoodsServicesDetails
+____/GoodsServices
+______/ClassDescriptionDetails
+________/ClassDescription
+__________/ClassNumber
+__________/ClassNumberStatusCode
+__________/GoodsServicesDescription
+__________/GoodsServicesDescription[@languageCode=FR]
+__________/GoodsServicesDescription[@languageCode=fr]
+______/ClassificationKindCode
+______/Comment
+__/KindMark
+__/MarkCurrentStatusCode
+__/MarkDescriptionDetails
+____/MarkDescription
+__/MarkDisclaimerDetails
+____/MarkDisclaimer
+__/MarkFeature
+__/MarkImageDetails
+____/MarkImage
+______/MarkImageCategory
+________/CategoryCodeDetails
+__________/CategoryCode
+________/CategoryKind
+______/MarkImageColourIndicator
+______/MarkImageFileFormat
+______/MarkImageFilename
+__/MarkRecordDetails
+____/MarkRecord
+______/BasicRecord
+________/BasicRecordKind
+________/ClaimantDetails
+__________/Claimant
+____________/ClaimantAddressBook
+______________/FormattedNameAddress
+________________/Address
+__________________/AddressCountryCode
+__________________/FormattedAddress
+____________________/AddressCity
+____________________/AddressPostcode
+____________________/AddressStreet
+________________/Name
+__________________/FormattedName
+____________________/LastName
+____________________/OrganizationName
+____________/ClaimantIdentifier
+________/GoodsServicesLimitationDetails
+__________/GoodsServicesLimitation
+____________/LimitationClassDescriptionDetails
+______________/ClassDescription
+________________/ClassNumber
+________________/GoodsServicesDescription
+________________/GoodsServicesDescription[@languageCode=fr]
+________/RecordEventDetails
+__________/RecordEvent
+____________/Comment
+____________/RecordEventCode
+________/RecordFilingDate
+________/RecordIdentifier
+________/RecordPublicationDetails
+__________/RecordPublication
+____________/PublicationDate
+____________/PublicationIdentifier
+________/RecordReference
+__/MarkSoundDetails
+____/MarkSound
+______/MarkSoundFileFormat
+______/MarkSoundFilename
+______/MarkSoundFilename[@SHA256=8c9f58dfd25ba28f9e3e77e6ceb445bb4a48418b9383ced990371cb54a7004a0]
+__/MarkVideoDetails
+____/MarkVideo
+______/MarkVideoFileFormat
+______/MarkVideoFilename
+______/MarkVideoFilename[@SHA256=3ded056614d70c259762fc9d235731b491708e699ebb8b571ffd6527e9b9d098]
+______/MarkVideoFilename[@SHA256=a8ba0a555cb5c08aace3c5475df59fe5806da902f39a42f0d6b5ac8fe08e4b8b]
+__/PreviousRegistrationDetails
+____/PreviousRegistration
+______/PreviousRegistrationDate
+______/PreviousRegistrationNumber
+__/PriorityDetails
+____/Priority
+______/Comment
+______/PriorityCountryCode
+______/PriorityDate
+______/PriorityNumber
+__/RegistrationOfficeCode
+__/RepresentativeDetails
+____/Representative
+______/RepresentativeAddressBook
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressBuilding
+______________/AddressCity
+______________/AddressPostOfficeBox
+______________/AddressPostcode
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/LastName
+______________/OrganizationName
+______/RepresentativeIdentifier
+______/RepresentativeIdentifier[@identifierKindCode=DE]
+______/RepresentativeIdentifier[@identifierKindCode=FR]
+______/RepresentativeIdentifier[@identifierKindCode=LU]
+______/RepresentativeLegalEntity
+______/RepresentativeSequenceNumber
+__/TradeMarkVersion
+____/VersionNumber
+__/WordMarkSpecification
+____/MarkTranslation
+____/MarkTransliteration
+____/MarkVerbalElementText
+__/ApplicantDetails
+____/Applicant
+______/ApplicantAddressBook
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressBuilding
+______________/AddressCity
+______________/AddressPostOfficeBox
+______________/AddressPostcode
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/IndividualIdentifier
+______________/LastName
+______________/OrganizationName
+______/ApplicantIdentifier
+______/ApplicantIdentifier[@identifierKindCode=CN]
+______/ApplicantIdentifier[@identifierKindCode=FR]
+______/ApplicantIdentifier[@identifierKindCode=IT]
+______/ApplicantIdentifier[@identifierKindCode=JP]
+______/ApplicantIdentifier[@identifierKindCode=MC]
+______/ApplicantLegalEntity
+______/ApplicantSequenceNumber
+______/Comment
+__/ApplicationDate
+__/ApplicationLanguageCode
+__/ApplicationNumber
+__/AssociatedMarkDetails
+____/AssociatedApplicationNumber
+__/Comment
+__/DivisionalApplicationDetails
+____/InitialApplicationDate
+____/InitialApplicationNumber
+____/InitialApplicationRegistrationDate
+__/ExpiryDate
+__/FilingPlace
+__/GoodsServicesDetails
+____/GoodsServices
+______/ClassDescriptionDetails
+________/ClassDescription
+__________/ClassNumber
+__________/ClassNumberStatusCode
+__________/GoodsServicesDescription
+__________/GoodsServicesDescription[@languageCode=fr]
+______/ClassificationKindCode
+______/Comment
+__/KindMark
+__/MarkCurrentStatusCode
+__/MarkDescriptionDetails
+____/MarkDescription
+__/MarkDisclaimerDetails
+____/MarkDisclaimer
+__/MarkFeature
+__/MarkImageDetails
+____/MarkImage
+______/MarkImageCategory
+________/CategoryCodeDetails
+__________/CategoryCode
+________/CategoryKind
+______/MarkImageColourIndicator
+______/MarkImageFileFormat
+______/MarkImageFilename
+__/MarkRecordDetails
+____/MarkRecord
+______/BasicRecord
+________/BasicRecordKind
+________/ClaimantDetails
+__________/Claimant
+____________/ClaimantAddressBook
+______________/FormattedNameAddress
+________________/Address
+__________________/AddressCountryCode
+__________________/FormattedAddress
+____________________/AddressCity
+____________________/AddressPostcode
+____________________/AddressStreet
+________________/Name
+__________________/FormattedName
+____________________/LastName
+____________________/OrganizationName
+____________/ClaimantIdentifier
+________/GoodsServicesLimitationDetails
+__________/GoodsServicesLimitation
+____________/LimitationClassDescriptionDetails
+______________/ClassDescription
+________________/ClassNumber
+________________/GoodsServicesDescription
+________________/GoodsServicesDescription[@languageCode=fr]
+________/RecordFilingDate
+________/RecordIdentifier
+________/RecordPublicationDetails
+__________/RecordPublication
+____________/PublicationDate
+____________/PublicationIdentifier
+________/RecordReference
+__/MarkSoundDetails
+____/MarkSound
+______/MarkSoundFileFormat
+______/MarkSoundFilename
+__/MarkVideoDetails
+____/MarkVideo
+______/MarkVideoFileFormat
+______/MarkVideoFilename
+__/PreviousRegistrationDetails
+____/PreviousRegistration
+______/PreviousRegistrationDate
+______/PreviousRegistrationNumber
+__/PriorityDetails
+____/Priority
+______/Comment
+__/RegistrationOfficeCode
+__/RepresentativeDetails
+____/Representative
+______/RepresentativeAddressBook
+________/FormattedNameAddress
+__________/Address
+____________/AddressCountryCode
+____________/FormattedAddress
+______________/AddressBuilding
+______________/AddressCity
+______________/AddressPostOfficeBox
+______________/AddressPostcode
+______________/AddressStreet
+__________/Name
+____________/FormattedName
+______________/LastName
+______________/OrganizationName
+______/RepresentativeIdentifier
+______/RepresentativeIdentifier[@identifierKindCode=FR]
+______/RepresentativeIdentifier[@identifierKindCode=IT]
+______/RepresentativeSequenceNumber
+__/TradeMarkVersion
+____/VersionNumber
+__/WordMarkSpecification
+____/MarkTranslation
+____/MarkTransliteration
+____/MarkVerbalElementText

gbdtransformation/brands/frtm/template.yml

@@ -0,0 +1,203 @@
+# No Reference to International Marks are made (Madrid Registration)
+# Assumptions:
+# - Registration number = Application number when registered
+# - Registration date = BasicRecord['Enregistrement']/PublicationDate
+# - Registration date = BasicRecord['Enregistrement']/PublicationIdentifier (when it matches yyyy-ww)
+# - Status date = BasicRecord[0]/PublicationDate
+
+{% from 'navigation.tmpl' import match %}
+{% set status = TradeMark | translate_status %}
+
+st13: {{ TradeMark.ApplicationNumber | st13('FR', appdate=TradeMark.ApplicationDate) }}
+gbdStatus: {{ status }}
+registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
+type: TRADEMARK
+
+{% if not status == 'Delete' %}
+kind: {{ TradeMark.KindMark | translate_kind }}
+
+designatedCountries:
+  - {{ TradeMark.RegistrationOfficeCode }}
+
+filingPlace: {{ TradeMark.FilingPlace }}
+
+
+publicationDate: {{ TradeMark | get_publication_date }}
+
+applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationDate: {{ TradeMark.ApplicationDate }}
+
+registrationNumber: {{ TradeMark | get_registration_number  }}
+registrationDate: {{ TradeMark | get_registration_date }}
+
+applicationLanguageCode: {{ TradeMark.ApplicationLanguageCode }}
+
+expiryDate: {{ TradeMark.ExpiryDate }}
+
+officeStatus: {{ TradeMark.MarkCurrentStatusCode }}
+statusDate: {{ TradeMark | get_status_date }}
+{% if status == 'Ended' %}
+terminationDate: {{ TradeMark | get_status_date }}
+{% endif %}
+markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+
+markDescriptionDetails:
+  {% call(desc) match('MarkDescriptionDetails.MarkDescription', TradeMark) %}
+  - text: {{ desc  }}
+    languageCode: {{ desc | guess_language('', TradeMark.ApplicationLanguageCode) }}
+  {% endcall %}
+
+markDisclaimerDetails:
+  - text: {{ TradeMark.Comment }}
+    languageCode: {{ TradeMark.Comment | guess_language('', TradeMark.ApplicationLanguageCode) }}
+
+wordMarkSpecification:
+  {% call(wordSpec) match('WordMarkSpecification', TradeMark) %}
+      {% call(verbal) match('MarkVerbalElementText', wordSpec) %}
+        markVerbalElement:
+          - languageCode: {{ verbal | guess_language(verbal._languageCode, TradeMark.ApplicationLanguageCode) }}
+            text: {{ verbal }}
+      {% endcall %}
+      {% call(trans) match('MarkTranslation', wordSpec) %}
+        markTranslation:
+          - text: {{ trans }}
+            languageCode: {{ trans | guess_language(trans._languageCode, TradeMark.ApplicationLanguageCode) }}
+      {% endcall %}
+        markTransliteration: {{ wordSpec.MarkTransliteration }}
+  {% endcall %}
+
+markDisclaimerDetails:
+  {% call(disclaimer) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  - text: {{ disclaimer.__value }}
+    languageCode: {{ disclaimer.__value | guess_language(disclaimer._languageCode, trademark.ApplicationLanguageCode) }}
+  {% endcall %}
+
+markImageDetails:
+  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
+    - name: {{ img.MarkImageFilename }}
+      colourIndicator: {{ img.MarkImageColourIndicator | get_true_or_false }}
+      {% call(category) match('MarkImageCategory', img) %}
+      {% if(category) %}
+      classification:
+        kind: Vienna #{{ category.CategoryKind }} they say Domestic but its vienna
+        version: {{ ASK_THE_OFFICE }}
+        code:
+          {% call(vc) match('CategoryCodeDetails.CategoryCode', category) %}
+            - {{ vc }}
+          {% endcall %}
+      {% endif %}
+      {% endcall %}
+  {% endcall %}
+
+markVideoDetails:
+{% call(video) match('MarkVideoDetails.MarkVideo', TradeMark)%}
+  - filename: {{ video.MarkVideoFilename }}
+    fileformat: {{ video.MarkVideoFileFormat }}
+{% endcall %}
+
+markSoundDetails:
+{% call(sound) match('MarkSoundDetails.MarkSound', TradeMark)%}
+  - filename: {{ sound.MarkSoundFilename }}
+    fileformat: {{ sound.MarkSoundFileFormat }}
+{% endcall %}
+
+{% call(nc_gs) match('GoodsServicesDetails.GoodsServices', TradeMark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+    {% call(nice) match('ClassDescriptionDetails.ClassDescription', nc_gs) %}
+    {% if nice.ClassNumber != '00' %}
+    - code: {{ nice.ClassNumber | int }}
+      terms:
+        {% if nice.GoodsServicesDescription.__value %}
+        fr:
+        {% for gsline in nice.GoodsServicesDescription.__value | remove_trailing('.') | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+        {% endif %}
+    {% endif %}
+    {% endcall %}
+
+goodsServicesUnclassified:
+{% call(nice) match('ClassDescriptionDetails.ClassDescription', nc_gs) %}
+{% if nice.ClassNumber == '00' %}
+  fr:
+  {% for gsline in nice.GoodsServicesDescription.__value | remove_trailing('.') | split_terms %}
+    - {{ gsline | lower }}
+  {% endfor %}
+{% endif %}
+{% endcall %}
+
+{% endcall %}
+
+
+applicants:
+  {% call(applicant) match('ApplicantDetails.Applicant', TradeMark) %}
+      - kind: {% if applicant.ApplicantLegalEntity %} Legal entity {% endif %}
+    {% call(details) match('ApplicantAddressBook.FormattedNameAddress.Name.FormattedName', applicant) %}
+        identifier: {{ details.IndividualIdentifier }}
+        fullName:
+          {% set aname = details.LastName or details.OrganizationName %}
+          - text: {{ aname }}
+            languageCode: {{ aname | guess_language('fr', Trademark.ApplicationLanguageCode) }}
+      {% endcall %}
+      {% call(address) match('ApplicantAddressBook.FormattedNameAddress.Address', applicant) %}
+        countryCode: {{ address.AddressCountryCode }}
+        fullAddress:
+          {% call(adrtag) match('FormattedAddress', address) %}
+          - text: {{ adrtag | get_full_address }}
+            languageCode: {{ adrtag | get_full_address | guess_language('fr', Trademark.ApplicationLanguageCode) }}
+          {% endcall %}
+      {% endcall %}
+    {% endcall %}
+
+representatives:
+  {% call(representative) match('RepresentativeDetails.Representative', TradeMark) %}
+    {% call(details) match('RepresentativeAddressBook.FormattedNameAddress.Name.FormattedName', representative) %}
+      - identifier: {{ representative.RepresentativeIdentifier }}
+        fullName:
+          {% set rname = details.LastName or details.OrganizationName %}
+          - text: {{ rname }}
+            languageCode: {{ rname | guess_language('fr', TradeMark.ApplicationLanguageCode) }}
+      {% endcall %}
+      {% call(address) match('RepresentativeAddressBook.FormattedNameAddress.Address', representative) %}
+        fullAddress:
+          {% call(adrtag) match('FormattedAddress', address) %}
+          - text: {{ adrtag | get_full_address }}
+            languageCode: {{ adrtag | get_full_address | guess_language('fr', Trademark.ApplicationLanguageCode) }}
+          {% endcall %}
+        countryCode: {{ address.AddressCountryCode }}
+      {% endcall %}
+    {% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+    - countryCode: {{ priority.PriorityCountryCode }}
+      number: {{ priority.PriorityNumber | remove_trailing('-') }}
+      date: {{ priority.PriorityDate }}
+      comment: {{ priority.Comment }}
+  {% endcall %}
+
+publications:
+  {% call(record) match('MarkRecordDetails.MarkRecord', TradeMark) %}
+  {% call(publication) match('BasicRecord.RecordPublicationDetails.RecordPublication', record) %}
+    - identifier: {{ publication.PublicationIdentifier }}
+      date: {{ publication.PublicationDate }}
+      section: {{ record.BasicRecord.BasicRecordKind }}
+  {% endcall %}
+  {% endcall %}
+
+events:
+  {% call(event) match('MarkEventDetails.MarkEvent', TradeMark) %}
+    - officeKind: {{ event.MarkEventCode }}
+      gbdKind: {{ event.MarkEventCode }}
+      date: {{ event.MarkEventDate }}
+  {% endcall %}
+
+extra:
+  {% call(prev) match('PreviousRegistrationDetails.PreviousRegistration', TradeMark)%}
+  - previousRegistration: {{ prev.PreviousRegistrationNumber }}
+  {% endcall %}
+
+{% endif %}

gbdtransformation/brands/gbtm/__init__.py

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

gbdtransformation/brands/gbtm/filters.py

@@ -0,0 +1,122 @@
+# namespaces defined in XML and to be ignored in procecssing
+import os.path
+from datetime import datetime
+ignore_namespace = []
+
+def multipleFileds(original, api):
+    if not original:
+        return api
+    return original
+
+def format_addr(value):
+    if isinstance(value, list):
+        return ' '.join(value)
+    return  value
+
+def convertdateGB(date):
+    """Date convertor from input_format to output_format"""
+    if not date:
+        return None
+    output_format = "%Y-%m-%d"
+    for input_format in ['%Y-%m-%dT%H:%M:%S.000+01:00', '%Y-%m-%dZ', '%Y-%m-%dT%H:%M:%S.000Z', "%Y%m%d"]:
+        try:
+            return datetime.strptime(date, input_format).strftime(output_format)
+        except ValueError:
+            continue
+    return date
+
+def  get_entity_addr(addr):
+    if not addr: return None
+    if not isinstance(addr.AddressLine, list):
+        addr.AddressLine = [addr.AddressLine]
+    addr.AddressLine = [x for x in addr.AddressLine if x is not None]
+    return ("%s %s %s" % ('\n'.join(addr.AddressLine), addr.Town, addr.Postcode)).replace("None", "").strip()
+
+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'
+
+def parse_img_path(value):
+    return os.path.basename(value)
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+def translate_kind(kind):
+    if kind == 'Individual': return ['Individual']
+    if kind == 'Collective': return ['Collective']
+    if kind == 'State property': return ['Collective']
+    if kind == 'Certificate': return ['Certificate']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+
+def translate_status(status):
+    if not status: return 'Unknown'
+    if status == 'Registration cancelled': return 'Expired'
+    if status == 'Expired': return 'Expired'
+    if status == 'Registration surrendered': return 'Expired'
+
+    if status in [ 'Registered','Registration renewed']:
+        return 'Registered'
+    if status in ['DO-NOT-DISPLAY']:
+        return 'Delete'
+    if status in [ 'Cancelled','Merged' ,'Removed', 'Withdrawn','Refused','Surrendered',
+                   'Dead', ]:
+        return 'Ended'
+
+    if status in [ 'Application Published',
+                   'Pre-Publication',
+                   'Examination',
+                   'Application Received',
+                   'Opposed',
+                   'Opposition pending',
+                   'Appeal pending' ]:
+        return 'Pending'
+    if status in ['Application filed',
+                  'Application published',
+                  'Application under examination',
+                  'Registration pending',
+                  'Appeal pending',
+                  'Registration cancellation pending']:
+        return 'Pending'
+
+    if status in ['Application refused',
+                  'Application withdrawn',
+                  'Application opposed',
+                  'Registration cancelled',
+                  'Registration surrendered']:
+        return 'Ended'
+
+    if status == 'Registered': return 'Registered'
+    if status == 'Registration expired': return 'Expired'
+    raise Exception('Status "%s" unmapped' % status)
+
+def sanitize(value):
+    if isinstance(value, dict):
+        value = value['__value']
+    return value.replace('\n', '')
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+    if feature == 'Hologram': return 'Hologram'
+    if feature == 'Motion': return 'Motion'
+    if feature == 'Olfactory': return 'Olfactory'
+    if feature == 'Multimedia': return 'Multimedia'
+    if feature == 'Other': return 'Other'
+    if feature == 'Pattern': return 'Pattern'
+    if feature == 'Undefined': return 'Undefined'
+    if feature == 'Word': return 'Word'
+    if feature == 'Figurative': return 'Figurative'
+    if feature == 'Combined': return 'Combined'
+    if feature == '3-D': return 'Three dimensional'
+    if feature == 'Sound': return 'Sound'
+    if feature == 'Colour': return 'Colour'
+    raise Exception('Feature "%s" unmapped' % feature)