Add support for biblatex-software

.gitignore

@@ -105,3 +105,6 @@ ENV/
 # IDE
 .idea
 .vscode
+
+# Vim temp files
+*.swp

README.dev.md

@@ -66,12 +66,13 @@ Tests pertaining to a specific exporter have been marked accordingly with one of
 `pytest` configuration section in `pyproject.toml`):
 
 1. `apalike`
-2. `bibtex`
-3. `codemeta`
-4. `endnote`
-5. `ris`
-6. `schemaorg`
-7. `zenodo`
+2. `biblatex`
+3. `bibtex`
+4. `codemeta`
+5. `endnote`
+6. `ris`
+7. `schemaorg`
+8. `zenodo`
 
 Additionally, there are markers for CLI tests and for library tests:
 

pyproject.toml

@@ -110,6 +110,7 @@ src_paths = ["src", "tests"]
 addopts = "--no-cov --verbose --maxfail=1 --strict-markers --import-mode=importlib --cache-clear --strict-config"
 markers = [
     "apalike: Tests pertaining to 'apalike' export behavior",
+    "biblatex: Tests pertaining to 'biblatex' export behavior",
     "bibtex: Tests pertaining to 'bibtex' export behavior",
     "cli: Tests pertaining to cffconvert's command line interface",
     "codemeta: Tests pertaining to 'codemeta' export behavior",

src/cffconvert/cli/cli.py

@@ -21,6 +21,7 @@
     "outputformat": {
         "type": click.Choice([
             "apalike",
+            "biblatex",
             "bibtex",
             "cff",
             "codemeta",

src/cffconvert/cli/validate_or_write_output.py

@@ -26,6 +26,7 @@ def validate_or_write_output(outfile, outputformat, validate_only, citation, ver
             ctx.exit(1)
         outstr = {
             "apalike": citation.as_apalike,
+            "biblatex": citation.as_biblatex,
             "bibtex": citation.as_bibtex,
             "cff": citation.as_cff,
             "codemeta": citation.as_codemeta,

src/cffconvert/gcloud/gcloud.py

@@ -64,13 +64,14 @@ def cffconvert(request):
         outstr += f"Data passes validation according to Citation File Format schema version {citation.cffversion}."
         return Response(outstr, mimetype=mimetype_plain)
 
-    acceptable_output_formats = ["apalike", "bibtex", "cff", "codemeta", "endnote", "schema.org", "ris", "zenodo"]
+    acceptable_output_formats = ["apalike", "biblatex", "bibtex", "cff", "codemeta", "endnote", "schema.org", "ris", "zenodo"]
     if outputformat not in acceptable_output_formats:
         outstr += f"\n\n'outputformat' should be one of [{', '.join(acceptable_output_formats)}]"
         return Response(outstr, mimetype=mimetype_plain)
 
     outstr += {
         "apalike": citation.as_apalike,
+        "biblatex": citation.as_biblatex,
         "bibtex": citation.as_bibtex,
         "cff": citation.as_cff,
         "codemeta": citation.as_codemeta,

src/cffconvert/lib/cff_1_0_x/biblatex.py

@@ -0,0 +1,43 @@
+from cffconvert.lib.cff_1_x_x.authors.biblatex import BiblatexAuthor
+from cffconvert.lib.cff_1_x_x.biblatex import BiblatexObjectShared as Shared
+from cffconvert.lib.cff_1_x_x.urls.biblatex import BiblatexUrl
+
+
+class BiblatexObject(Shared):
+
+    supported_cff_versions = [
+        "1.0.1",
+        "1.0.2",
+        "1.0.3"
+    ]
+
+    def add_author(self):
+        authors_cff = self.cffobj.get("authors", [])
+        authors_biblatex = [BiblatexAuthor(a).as_string() for a in authors_cff]
+        authors_biblatex_filtered = [a for a in authors_biblatex if a is not None]
+        self.author = "author = {" + " and ".join(authors_biblatex_filtered) + "}"
+        return self
+
+    def add_doi(self):
+        if "doi" in self.cffobj.keys():
+            self.doi = "doi = {" + self.cffobj["doi"] + "}"
+        return self
+
+    def add_month(self):
+        if "date-released" in self.cffobj.keys():
+            self.month = "month = {" + str(self.cffobj["date-released"].month) + "}"
+        return self
+
+    def add_url(self):
+        self.url = BiblatexUrl(self.cffobj).as_string()
+        return self
+
+    def add_year(self):
+        if "date-released" in self.cffobj.keys():
+            self.year = "year = {" + str(self.cffobj["date-released"].year) + "}"
+        return self
+
+    def add_date(self):
+        if "date-released" in self.cffobj.keys():
+            self.date = "date = {" + self.cffobj["date-released"].isoformat() + "}"
+        return self

src/cffconvert/lib/cff_1_0_x/citation.py

@@ -3,6 +3,7 @@
 from ruamel.yaml import SafeConstructor
 from ruamel.yaml import YAML
 from cffconvert.lib.cff_1_0_x.apalike import ApalikeObject
+from cffconvert.lib.cff_1_0_x.biblatex import BiblatexObject
 from cffconvert.lib.cff_1_0_x.bibtex import BibtexObject
 from cffconvert.lib.cff_1_0_x.codemeta import CodemetaObject
 from cffconvert.lib.cff_1_0_x.endnote import EndnoteObject
@@ -57,6 +58,9 @@ def _parse(self):
     def as_apalike(self):
         return ApalikeObject(self.cffobj).as_string()
 
+    def as_biblatex(self):
+        return BiblatexObject(self.cffobj).as_string()
+
     def as_bibtex(self):
         return BibtexObject(self.cffobj).as_string()
 

src/cffconvert/lib/cff_1_1_x/biblatex.py

@@ -0,0 +1,47 @@
+from cffconvert.lib.cff_1_x_x.authors.biblatex import BiblatexAuthor
+from cffconvert.lib.cff_1_x_x.biblatex import BiblatexObjectShared as Shared
+from cffconvert.lib.cff_1_x_x.urls.biblatex import BiblatexUrl
+
+
+class BiblatexObject(Shared):
+
+    supported_cff_versions = [
+        "1.1.0"
+    ]
+
+    def add_author(self):
+        authors_cff = self.cffobj.get("authors", [])
+        authors_biblatex = [BiblatexAuthor(a).as_string() for a in authors_cff]
+        authors_biblatex_filtered = [a for a in authors_biblatex if a is not None]
+        self.author = "author = {" + " and ".join(authors_biblatex_filtered) + "}"
+        return self
+
+    def add_doi(self):
+        if "doi" in self.cffobj.keys():
+            self.doi = "doi = {" + self.cffobj["doi"] + "}"
+        if "identifiers" in self.cffobj.keys():
+            identifiers = self.cffobj["identifiers"]
+            for identifier in identifiers:
+                if identifier["type"] == "doi":
+                    self.doi = "doi = {" + identifier["value"] + "}"
+                    break
+        return self
+
+    def add_month(self):
+        if "date-released" in self.cffobj.keys():
+            self.month = "month = {" + str(self.cffobj["date-released"].month) + "}"
+        return self
+
+    def add_url(self):
+        self.url = BiblatexUrl(self.cffobj).as_string()
+        return self
+
+    def add_year(self):
+        if "date-released" in self.cffobj.keys():
+            self.year = "year = {" + str(self.cffobj["date-released"].year) + "}"
+        return self
+
+    def add_date(self):
+        if "date-released" in self.cffobj.keys():
+            self.date = "date = {" + self.cffobj["date-released"].isoformat() + "}"
+        return self

src/cffconvert/lib/cff_1_1_x/citation.py

@@ -3,6 +3,7 @@
 from ruamel.yaml import SafeConstructor
 from ruamel.yaml import YAML
 from cffconvert.lib.cff_1_1_x.apalike import ApalikeObject
+from cffconvert.lib.cff_1_1_x.biblatex import BiblatexObject
 from cffconvert.lib.cff_1_1_x.bibtex import BibtexObject
 from cffconvert.lib.cff_1_1_x.codemeta import CodemetaObject
 from cffconvert.lib.cff_1_1_x.endnote import EndnoteObject
@@ -55,6 +56,9 @@ def _parse(self):
     def as_apalike(self):
         return ApalikeObject(self.cffobj).as_string()
 
+    def as_biblatex(self):
+        return BiblatexObject(self.cffobj).as_string()
+
     def as_bibtex(self):
         return BibtexObject(self.cffobj).as_string()
 

src/cffconvert/lib/cff_1_2_x/biblatex.py

@@ -0,0 +1,48 @@
+from cffconvert.lib.cff_1_x_x.authors.biblatex import BiblatexAuthor
+from cffconvert.lib.cff_1_x_x.biblatex import BiblatexObjectShared as Shared
+from cffconvert.lib.cff_1_x_x.urls.biblatex import BiblatexUrl
+
+
+class BiblatexObject(Shared):
+
+    supported_cff_versions = [
+        "1.2.0"
+    ]
+
+    def add_author(self):
+        authors_cff = self.cffobj.get("authors", [])
+        authors_biblatex = [BiblatexAuthor(a).as_string() for a in authors_cff]
+        authors_biblatex_filtered = [a for a in authors_biblatex if a is not None]
+        self.author = "author = {" + " and ".join(authors_biblatex_filtered) + "}"
+        return self
+
+    def add_doi(self):
+        if "doi" in self.cffobj.keys():
+            self.doi = "doi = {" + self.cffobj["doi"] + "}"
+        if "identifiers" in self.cffobj.keys():
+            identifiers = self.cffobj["identifiers"]
+            for identifier in identifiers:
+                if identifier["type"] == "doi":
+                    self.doi = "doi = {" + identifier["value"] + "}"
+                    break
+        return self
+
+    def add_month(self):
+        if "date-released" in self.cffobj.keys():
+            month = self.cffobj["date-released"].split("-")[1].lstrip("0")
+            self.month = "month = {" + month + "}"
+        return self
+
+    def add_url(self):
+        self.url = BiblatexUrl(self.cffobj).as_string()
+        return self
+
+    def add_year(self):
+        if "date-released" in self.cffobj.keys():
+            self.year = "year = {" + self.cffobj["date-released"][:4] + "}"
+        return self
+
+    def add_date(self):
+        if "date-released" in self.cffobj.keys():
+            self.date = "date = {" + self.cffobj["date-released"] + "}"
+        return self

src/cffconvert/lib/cff_1_2_x/citation.py

@@ -5,6 +5,7 @@
 from ruamel.yaml import SafeConstructor
 from ruamel.yaml import YAML
 from cffconvert.lib.cff_1_2_x.apalike import ApalikeObject
+from cffconvert.lib.cff_1_2_x.biblatex import BiblatexObject
 from cffconvert.lib.cff_1_2_x.bibtex import BibtexObject
 from cffconvert.lib.cff_1_2_x.codemeta import CodemetaObject
 from cffconvert.lib.cff_1_2_x.endnote import EndnoteObject
@@ -57,6 +58,9 @@ def _parse(self):
     def as_apalike(self):
         return ApalikeObject(self.cffobj).as_string()
 
+    def as_biblatex(self):
+        return BiblatexObject(self.cffobj).as_string()
+
     def as_bibtex(self):
         return BibtexObject(self.cffobj).as_string()
 

src/cffconvert/lib/cff_1_3_x/biblatex.py

@@ -0,0 +1,48 @@
+from cffconvert.lib.cff_1_x_x.authors.biblatex import BiblatexAuthor
+from cffconvert.lib.cff_1_x_x.biblatex import BiblatexObjectShared as Shared
+from cffconvert.lib.cff_1_x_x.urls.biblatex import BiblatexUrl
+
+
+class BiblatexObject(Shared):
+
+    supported_cff_versions = [
+        "1.3.0"
+    ]
+
+    def add_author(self):
+        authors_cff = self.cffobj.get("authors", [])
+        authors_biblatex = [BiblatexAuthor(a).as_string() for a in authors_cff]
+        authors_biblatex_filtered = [a for a in authors_biblatex if a is not None]
+        self.author = "author = {" + " and ".join(authors_biblatex_filtered) + "}"
+        return self
+
+    def add_doi(self):
+        if "doi" in self.cffobj.keys():
+            self.doi = "doi = {" + self.cffobj["doi"] + "}"
+        if "identifiers" in self.cffobj.keys():
+            identifiers = self.cffobj["identifiers"]
+            for identifier in identifiers:
+                if identifier["type"] == "doi":
+                    self.doi = "doi = {" + identifier["value"] + "}"
+                    break
+        return self
+
+    def add_month(self):
+        if "date-released" in self.cffobj.keys():
+            month = self.cffobj["date-released"].split("-")[1].lstrip("0")
+            self.month = "month = {" + month + "}"
+        return self
+
+    def add_url(self):
+        self.url = BiblatexUrl(self.cffobj).as_string()
+        return self
+
+    def add_year(self):
+        if "date-released" in self.cffobj.keys():
+            self.year = "year = {" + self.cffobj["date-released"][:4] + "}"
+        return self
+
+    def add_date(self):
+        if "date-released" in self.cffobj.keys():
+            self.date = "date = {" + self.cffobj["date-released"] + "}"
+        return self

src/cffconvert/lib/cff_1_3_x/citation.py

@@ -5,6 +5,7 @@
 from ruamel.yaml import SafeConstructor
 from ruamel.yaml import YAML
 from cffconvert.lib.cff_1_3_x.apalike import ApalikeObject
+from cffconvert.lib.cff_1_3_x.biblatex import BiblatexObject
 from cffconvert.lib.cff_1_3_x.bibtex import BibtexObject
 from cffconvert.lib.cff_1_3_x.codemeta import CodemetaObject
 from cffconvert.lib.cff_1_3_x.endnote import EndnoteObject
@@ -57,6 +58,9 @@ def _parse(self):
     def as_apalike(self):
         return ApalikeObject(self.cffobj).as_string()
 
+    def as_biblatex(self):
+        return BiblatexObject(self.cffobj).as_string()
+
     def as_bibtex(self):
         return BibtexObject(self.cffobj).as_string()