Added v0.4.0 release notes (#92)

docs/source/interaction.rst

@@ -246,11 +246,10 @@ To use Resources with other libraries such as pandas, different data conversion
 
    as_json(data: Union[Resource, List[Resource]], expanded: bool = False, store_metadata: bool = False) -> Union[Dict, List[Dict]]
    as_jsonld(data: Union[Resource, List[Resource]], compacted: bool = True, store_metadata: bool = False) -> Union[Dict, List[Dict]]
-   as_triples(data: Union[Resource, List[Resource]], store_metadata: bool = False) -> List[Tuple[str, str, str]]
+   as_graph(data: Union[Resource, List[Resource]], store_metadata: bool = False) -> Graph
    as_dataframe(data: List[Resource], na: Union[Any, List[Any]] = [None], nesting: str = ".", expanded: bool = False, store_metadata: bool = False) -> DataFrame
    from_json(data: Union[Dict, List[Dict]], na: Union[Any, List[Any]] = None) -> Union[Resource, List[Resource]]
    from_jsonld(data: Union[Dict, List[Dict]]) -> Union[Resource, List[Resource]]
-   from_triples(data: List[Tuple[str, str, str]]) -> Union[Resource, List[Resource]]
    from_dataframe(data: DataFrame, na: Union[Any, List[Any]] = np.nan, nesting: str = ".") -> Union[Resource, List[Resource]]
 
 Formatting

docs/source/releases/v0.4.0-release-notes.rst

@@ -0,0 +1,123 @@
+====================
+vO.4.0 Release Notes
+====================
+
+This release adds incremental features to both Nexus Forge core and specializations modules. This release also implemented many fixes to various issues raised by users.
+
+New Features
+============
+
+Querying
+--------
+
+* Add cross-bucket search feature `#71 <https://github.com/BlueBrain/nexus-forge/pull/71>`__ `#74 <https://github.com/BlueBrain/nexus-forge/pull/74>`__ (issue:`#63 <https://github.com/BlueBrain/nexus-forge/pull/63>`__)(usage: 04 - Querying notebook on `Github <https://github.com/BlueBrain/nexus-forge/blob/v0.4.0/examples/notebooks/getting-started/04%20-%20Querying.ipynb>`__ or on |Binder|)
+
+If cross_bucket is set to True, resources could be retrieved by identifier from multiple buckets. In such case, a specific bucket can be target using the `bucket` argument.
+
+Usage:
+
+.. code-block:: python
+
+   resource = forge.search(<resource_id>, cross_bucket=True, bucket=<str>)
+
+.. note::
+
+   The configured store should support cross bucket search.
+
+* Add support for targeting specific search endpoint when searching data. Currently only SPARQL endpoints are supported `#71 <https://github.com/BlueBrain/nexus-forge/pull/71>`__ (issue:`#63 <https://github.com/BlueBrain/nexus-forge/pull/63>`__)(usage: 04 - Querying notebook on `Github <https://github.com/BlueBrain/nexus-forge/blob/v0.4.0/examples/notebooks/getting-started/04%20-%20Querying.ipynb>`__ or on |Binder|)
+
+A `searchendpoints` configuration can be added to the `Store` configuration.
+
+.. code-block:: python
+
+   "Store": {
+           "name": <str>,
+           "endpoint": <str>,
+           "bucket": <str>,
+           "token": <str>,
+           "searchendpoints": {
+                "<querytype>": { # <a query paradigm supported by the store (e.g. sparql)>
+                "endpoint": <str> #<an IRI of a query endpoint>
+            }
+           },
+           "versioned_id_template": <str>,
+           "file_resource_mapping": <str>
+   }
+
+Enhancements
+============
+
+Forge
+-----
+
+* Add creating a forge session from a configuration URL `#91 <https://github.com/BlueBrain/nexus-forge/pull/91>`__ (issue:`#65 <https://github.com/BlueBrain/nexus-forge/pull/65>`__)
+
+.. code-block:: python
+
+   forge = KnowledgeGraphForge(configuration="https://...config.json") # or config.yml
+
+Querying
+--------
+
+* Add query param support when retrieving a resource `#79 <https://github.com/BlueBrain/nexus-forge/pull/79>`__
+
+.. code-block:: python
+
+   resource = forge.retrieve(id=https://..?rev=1&p=aparam)
+
+Specifically, when the version argument is provided like in:
+
+.. code-block:: python
+
+   resource = forge.retrieve(id=https://..?rev=1&p=aparam, version=2)
+
+
+then it supersedes the `rev` query param while the other query params (e.g `p=aparam`) are kept as they are.
+
+
+Dataset
+-------
+
+* Dataset provenance assertion methods are now all aligned to accept either a `Resource` object of identifier. `#88 <https://github.com/BlueBrain/nexus-forge/pull/88>`__ (usage: 02 - Dataset notebook on `Github <https://github.com/BlueBrain/nexus-forge/blob/v0.4.0/examples/notebooks/getting-started/02%20-%20Dataset.ipynb>`__ or on |Binder|)
+
+.. code-block:: python
+
+   Dataset(forge: KnowledgeGraphForge, type: str = "Dataset", **properties)
+     add_contribution(resource: Union[str, Resource], versioned: bool = True, **kwargs) -> None
+     add_generation(resource: Union[str, Resource], versioned: bool = True, **kwargs) -> None
+     add_derivation(resource: Union[str, Resource], versioned: bool = True, **kwargs) -> None
+     add_invalidation(resource: Union[str, Resource], versioned: bool = True, **kwargs) -> None
+
+When a `Resourcce` is provided, `forge.freeze` will add the resource's version to its reference within the dataset enabling immutable identifier. `forge.freeze` is not supported when a resource identifier (str) is provided.
+
+Bug Fixes
+=========
+
+Forge
+-----
+
+* Fix `has no attribute '_rev'` error when calling `forge.freeze` on a `Dataset` object. `#81 <https://github.com/BlueBrain/nexus-forge/pull/81>`__ `#88 <https://github.com/BlueBrain/nexus-forge/pull/88>`__ (issue:`#80 <https://github.com/BlueBrain/nexus-forge/pull/80>`__)
+* Fix `RuntimeError` occuring when calling `nest_asyncio.apply()` outside a Jupyter notebook session `#62 <https://github.com/BlueBrain/nexus-forge/pull/62>`__ (issue:`#60 <https://github.com/BlueBrain/nexus-forge/pull/60>`__)
+* Fix failing `forge.download` when the provided path (e.g. distribution.contentUrl) is no longer present in all distributions json objects `#85 <https://github.com/BlueBrain/nexus-forge/pull/85>`__ (issue:`#84 <https://github.com/BlueBrain/nexus-forge/pull/84>`__)(usage: 02 - Dataset notebook on `Github <https://github.com/BlueBrain/nexus-forge/blob/v0.4.0/examples/notebooks/getting-started/02%20-%20Dataset.ipynb>`__ or on |Binder|)
+This is to cope with `schema.org/distribution <https://schema.org/distribution>`__ specification which supports `distribution.contentUrl` or `distribution.url` when recording the location of a dataset.
+
+Resolving
+---------
+
+* Fix `OntologyResolver` to resolve ontology terms when notation and prefLabel properties are missing `#76 <https://github.com/BlueBrain/nexus-forge/pull/76>`__ (issue:`#69 <https://github.com/BlueBrain/nexus-forge/pull/69>`__)(usage: 09 - Resolving notebook on `Github <https://github.com/BlueBrain/nexus-forge/blob/v0.4.0/examples/notebooks/getting-started/09%20-%20Resolving.ipynb>`__ or on |Binder|)
+
+Querying
+--------
+
+* Fix `BlueBrainNexus` store file retrieval support `#75 <https://github.com/BlueBrain/nexus-forge/pull/75>`__ (issue:`#64 <https://github.com/BlueBrain/nexus-forge/pull/64>`__)
+
+Converting
+----------
+
+*  Fix turning a list of `Resource` elements to `RDFlib Graph` using `forge.as_graph` while avoiding graph merge resulting from using graph set operation (such as +) `#87 <https://github.com/BlueBrain/nexus-forge/pull/87>`__
+
+
+
+.. |Binder| image:: https://mybinder.org/badge_logo.svg
+    :alt: Binder
+    :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.3.3?filepath=examples%2Fnotebooks%2Fgetting-started