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

gbdtransformation/brands/autm/template.yml

@@ -0,0 +1,157 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set is_series = TMEXTRACT.MARKDET.TYPMARI | contains('series') %}
+{% set nb_images = TMEXTRACT | get_nb_images %}
+{% set is_color_claimed =  TMEXTRACT.MARKDET.DISCLAI | contains('colour claimed') %}
+{% set mark_status =  TMEXTRACT.BASGR.BASSTA | translate_status %}
+{% set mark_feature = TMEXTRACT.MARKDET.TYPMARI | translate_feature(words=TMEXTRACT.MARKDET.MARDESC) %}
+{% set _comma = "," %}
+{% set _scoln = ";" %}
+{% set _space = " " %}
+
+type: TRADEMARK
+kind: {{ TMEXTRACT.OTHTMDET.TYPMARI | translate_kind }}
+markFeature: {{ mark_feature }}
+
+registrationOfficeCode: {{ TMEXTRACT.BASGR.OOCC }}
+designatedCountries:
+  - {{ TMEXTRACT.BASGR.OOCC }}
+
+reference:
+{% call(ir) match('INTREGG.INTREGN', TMEXTRACT) %}
+  office: WO
+  registration:
+    - number: {{ ir }}
+{% endcall %}
+
+st13: {{ TMEXTRACT.BASGR.BASAPPN | st13('AU', appdate=TMEXTRACT.BASGR.BASAPPD) }}
+applicationNumber: {{ TMEXTRACT.BASGR.BASAPPN }}
+applicationDate: {{ TMEXTRACT | get_application_date | convertdate('%Y%m%d') }}
+
+{% if mark_status == 'Registered' or mark_status == 'Expired' %}
+registrationNumber: {{ TMEXTRACT.BASGR.BASAPPN }}
+{% endif %}
+registrationDate: {{ TMEXTRACT | get_registration_date | convertdate('%Y%m%d') }}
+
+applicationLanguageCode: {{ TMEXTRACT.MARKDET.ORIGLAN | lower }}
+expiryDate: {{ TMEXTRACT | get_expiry_date | convertdate('%Y%m%d') }}
+
+officeStatus: {{ TMEXTRACT.BASGR.BASSTA }}
+gbdStatus:  {{ mark_status }}
+statusDate:
+
+wordMarkSpecification:
+  {% call(words) match('MARKDET.MARDESC', TMEXTRACT) %}
+  markVerbalElement:
+  {% for val in words | get_word_series(is_series) %}
+    - languageCode: {{ val | guess_language('en') }}
+      text: {{ val | trim }}
+  {% endfor %}
+  {% endcall %}
+
+{% if nb_images > 0 or is_color_claimed %}
+markImageDetails:
+  - name: {{ nb_images }}
+    {% if is_color_claimed %}
+    colourIndicator: {{ is_color_claimed }}
+    colourClaimed:
+      - languageCode: en
+        text: {{ TMEXTRACT.MARKDET.DISCLAI }}
+    {% endif %}
+    classification:
+      kind: KeyWords
+      version: AU
+      {% call(desc) match('MARKDET.DEVDESC', TMEXTRACT) %}
+      {% set desc_line = desc | remove_cr | remove_tab %}
+      code:
+      {% for val in desc_line.split(_comma) %}
+        - {{ val | trim }}
+      {% endfor %}
+      {% endcall %}
+{% endif %}
+
+{% if mark_feature == 'Sound' %}
+markSoundDetails:
+  - filename: {{ TODO }}
+    fileformat: {{ TODO }}
+{% endif %}
+
+{% if TMEXTRACT.GSGR %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(gs) match('GSGR', TMEXTRACT)%}
+    - code: {{ gs.NICCLAI | int }}
+      terms:
+        en :
+          {% for term in gs.GSTERMO | split_terms %}
+          - {{ term | trim | lower }}
+          {% endfor %}
+  {% endcall %}
+{% endif %}
+
+priorities:
+{% call(priority) match('PRIGR', TMEXTRACT)%}
+  - countryCode: {{ priority.COUNTRY }}
+    number: {{ priority.PRIAPPN }}
+    date: {{ priority.PRIAPPD | convertdate('%Y%m%d') }}
+    comment:
+{% endcall %}
+
+{% call(publication) match('PUBREG', TMEXTRACT)%}
+publications:
+  - identifier:
+    date: {{ publication.PUBREGD | convertdate('%Y%m%d') }}
+    section: {{ publication.PUBREGIS }}
+{% endcall %}
+
+{% set applicants = TMEXTRACT.APCTADD | unique_persons %}
+applicants:
+  {% for applicant in applicants %}
+  - identifier: {{ applicant.NAML8 }}
+    kind: {{ "Natural Person" if applicant.NAML3 else "Legal Entity"  }}
+    fullName:
+      - languageCode: {{ applicant | get_person_name | guess_language('en') }}
+        text: {{ applicant | get_person_name }}
+    fullAddress:
+      - languageCode: {{ applicant.ADDRL6 | guess_language('en') }}
+        text: {{ applicant.ADDRL6 | append(_space, applicant.POSTCDE) }}
+    countryCode: {{ applicant.COUNTRY }}
+  {% endfor %}
+
+{% set representatives = TMEXTRACT.SRVCADD | unique_persons %}
+representatives:
+  {% for representative in representatives %}
+  - identifier: {{ representative.NAML8 }}
+    kind: {{ "Natural Person" if representative.NAML3 else "Legal Entity"  }}
+    fullName:
+      - languageCode: {{ representative | get_person_name | guess_language('en') }}
+        text: {{ representative | get_person_name }}
+    fullAddress:
+      - languageCode: {{ representative.ADDRL6 | guess_language('en') }}
+        text: {{ representative.ADDRL6 | append(_space, representative.POSTCDE) }}
+    countryCode: {{ representative.COUNTRY }}
+  {% endfor %}
+
+{% call(corr) match('INTREGG.CORADD', TMEXTRACT) %}
+correspondence:
+  fullName:
+    - languageCode: {{ corr | get_person_name | guess_language('en') }}
+      text: {{ corr | get_person_name }}
+  fullAddress:
+    - languageCode: {{ corr.ADDRL6 | guess_language('en') }}
+      text: {{ corr.ADDRL6 | append(_space, corr.POSTCDE) }}
+  countryCode: {{ corr.COUNTRY }}
+{% endcall %}
+
+# events:
+#   - officeKind:
+#     gbdKind: # (Filed|Registered|Published|Opposed|Withdrawn)
+#     date:
+
+
+# here goes extra information that is office specific and that is pertinent for us to retain.
+extra:
+  isSeries: {{ is_series | get_true_or_false }}
+  imgCount: {{ nb_images }}

gbdtransformation/brands/bgtm/__init__.py

@@ -0,0 +1,5 @@
+# instruction to render the output to JSON format
+render = 'JSON'
+source = 'national'
+
+appnum_mask = '\\d{4}(\\d*)([A-Z]*)'

gbdtransformation/brands/bgtm/filters.py

@@ -0,0 +1,112 @@
+# standard gbd definitions
+from gbdtransformation.brands import kinds as std_kinds
+from gbdtransformation.brands import status as std_status
+from gbdtransformation.brands import features as std_features
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://www.euipo.europa.eu/EUTM/EUTM_Download',
+    'http://www.oami.europa.eu/TM-Search'
+]
+
+def filter_language(value, app_language):
+    if not value: return []
+
+    languages = set(['en', 'fr', 'es'])
+    languages.add(app_language.lower())
+    new_matches = []
+    for match in value:
+        if not match: continue
+        if not isinstance(match, dict):
+            new_matches.append(match)
+        elif not match.get('_languageCode', None):
+            new_matches.append(match)
+        elif match['_languageCode'].lower() in languages:
+            new_matches.append(match)
+    return new_matches
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def format_address(address):
+    return '%s, %s %s' % (address.AddressStreet,
+                          address.AddressPostcode,
+                          address.AddressCity)
+
+def format_name(name):
+    fname = name.FirstName
+    lname = name.LastName
+
+    full_name = [name.FirstName, name.LastName]
+    full_name = [f for f in full_name if f]
+
+    return ' '.join(full_name)
+
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    if kind == 'EU Certificate':
+        return ['Certificate']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature in ["3D shape", "3-D"]: return 'Three dimensional'
+
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    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
+
+def translate_status(trademark):
+    if trademark._operationCode == 'Delete':
+        return 'Delete'
+
+    status = trademark.MarkCurrentStatusCode
+
+    if status in ['Application filed',
+                  'Application published',
+                  'Application under examination',
+                  'Registration pending',
+                  'Appeal pending',
+                  'Registration cancellation pending',
+                  'Filed']:
+        return 'Pending'
+
+    if status in ['Application refused',
+                  'Application withdrawn',
+                  'Application opposed',
+                  'Registration cancelled',
+                  'Registration surrendered',
+                  'Ended']:
+        return 'Ended'
+
+    if status == 'Registered': return 'Registered'
+    if status in ['Registration expired', 'Expired']: return 'Expired'
+
+    raise Exception('Status "%s" not mapped.' % status)

gbdtransformation/brands/bgtm/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]