update docs and wos: deprecated fields

Author: Gerit Wagner

README.md

@@ -70,25 +70,21 @@ print(wos_query.to_string())
 # Output:
 # (AB="digital health" OR TI="digital health") AND (AB="privacy" OR TI="privacy")
 ```
-
-## Versioned Parsers & Serializers
-
-Parsers and serializers are versioned. The initial release starts with
-version `1.0.0` for every platform. You can explicitly pin a parser version
-when parsing a query:
-
+The translated query can be saved as follows:
 ```python
-from search_query.parser import parse
-
-query = parse("TS=(quantum)", platform="wos", version="1.0.0")
-```
-
-Queries stored on disk may also record their `version`.
-The `search-query upgrade` CLI command upgrades a search
-file to a target version via the intermediate representation:
-
-```bash
-search-query upgrade query.json --to 2.0.0
+from search_query import SearchFile
+
+search_file = SearchFile(
+    filename="search-file.json",
+    query_str=wos_query.to_string(platform="wos"),
+    platform="wos",
+    version="1.0.0",
+    authors=[{"name": "Tom Brady"}],
+    record_info={},
+    date={}
+)
+
+search_file.save()
 ```
 
 For a more detailed overview of the package’s functionality, see the [documentation](https://colrev-environment.github.io/search-query/).

docs/source/dev_docs/_autosummary/search_query.ebsco.rst

@@ -32,3 +32,4 @@ search\_query.ebsco
    search_query.ebsco.parser
    search_query.ebsco.serializer
    search_query.ebsco.translator
+   search_query.ebsco.v1_0_0

docs/source/dev_docs/_autosummary/search_query.ebsco.serializer.rst

@@ -9,8 +9,12 @@ search\_query.ebsco.serializer
 
 
 
-   .. rubric:: Functions
+
+
+
+
+   .. rubric:: Classes
 
    .. autosummary::
 
-      to_string_ebsco
+      EBSCOQuerySerializer

docs/source/dev_docs/_autosummary/search_query.ebsco.v1_0_0.parser.rst

@@ -0,0 +1,21 @@
+search\_query.ebsco.v1\_0\_0.parser
+===================================
+
+.. automodule:: search_query.ebsco.v1_0_0.parser
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      EBSCOListParser_v1_0_0
+      EBSCOParser_v1_0_0

docs/source/dev_docs/_autosummary/search_query.ebsco.v1_0_0.rst

@@ -0,0 +1,32 @@
+search\_query.ebsco.v1\_0\_0
+============================
+
+.. automodule:: search_query.ebsco.v1_0_0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   search_query.ebsco.v1_0_0.parser
+   search_query.ebsco.v1_0_0.serializer
+   search_query.ebsco.v1_0_0.translator

docs/source/dev_docs/_autosummary/search_query.ebsco.v1_0_0.serializer.rst

@@ -0,0 +1,20 @@
+search\_query.ebsco.v1\_0\_0.serializer
+=======================================
+
+.. automodule:: search_query.ebsco.v1_0_0.serializer
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      EBCOSerializer_v1_0_0

docs/source/dev_docs/_autosummary/search_query.ebsco.v1_0_0.translator.rst

@@ -0,0 +1,20 @@
+search\_query.ebsco.v1\_0\_0.translator
+=======================================
+
+.. automodule:: search_query.ebsco.v1_0_0.translator
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      EBSCOTranslator_v1_0_0

docs/source/dev_docs/_autosummary/search_query.generic.serializer.rst

@@ -9,8 +9,12 @@ search\_query.generic.serializer
 
 
 
-   .. rubric:: Functions
+
+
+
+
+   .. rubric:: Classes
 
    .. autosummary::
 
-      to_string_generic
+      GenericSerializer

docs/source/dev_docs/_autosummary/search_query.pubmed.rst

@@ -32,3 +32,4 @@ search\_query.pubmed
    search_query.pubmed.parser
    search_query.pubmed.serializer
    search_query.pubmed.translator
+   search_query.pubmed.v1_0_0

docs/source/dev_docs/_autosummary/search_query.pubmed.serializer.rst

@@ -9,8 +9,12 @@ search\_query.pubmed.serializer
 
 
 
-   .. rubric:: Functions
+
+
+
+
+   .. rubric:: Classes
 
    .. autosummary::
 
-      to_string_pubmed
+      PUBMEDQuerySerializer