From fe008202dcebb23be19d1030c347ac3d0c61458c Mon Sep 17 00:00:00 2001 From: Xavier Sosnovsky Date: Mon, 20 Nov 2023 15:13:30 +0100 Subject: [PATCH 1/4] Adopt Keep a Changelog conventions --- docs/release.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/release.rst b/docs/release.rst index 9856dd8..fe0324b 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -4,7 +4,10 @@ Release notes 1.0.0-beta-1 ------------ -- **Feature**: Implement core SDMX model classes -- **Feature**: Implement sync and async clients to retrieve metadata +Added +^^^^^ + +- Core SDMX model classes +- Sync and async clients to retrieve metadata from an SDMX Registry or SDMX-REST service -- **Feature**: Implement helper functions to handle SDMX URNs \ No newline at end of file +- Helper functions to handle SDMX URNs From 70178df96e3f4a8ef96c395bda1081eb6b5946a6 Mon Sep 17 00:00:00 2001 From: Xavier Sosnovsky Date: Mon, 20 Nov 2023 15:30:25 +0100 Subject: [PATCH 2/4] Create CHANGELOG.rst --- CHANGELOG.rst | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 CHANGELOG.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..e6b9d79 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,9 @@ +Changelog +========= + +All notable changes to this project are listed in the *release notes* published +with the `project documentation `_ . + +The format is based on `Keep a Changelog `_, +and this project adheres to +`Semantic Versioning `_. From e614640f547dd4074d7b346d7580070f6e710b8c Mon Sep 17 00:00:00 2001 From: Xavier Sosnovsky Date: Mon, 20 Nov 2023 15:48:09 +0100 Subject: [PATCH 3/4] Update README.rst --- README.rst | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 8689880..c4222fe 100644 --- a/README.rst +++ b/README.rst @@ -1,31 +1,25 @@ ``pysdmx`` in a nutshell ======================== -``pysdmx`` is an **opinionated** and **pragmatic** SDMX library written in -Python. It supports a **subset** of what SDMX offers and aims at -keeping things **simple** whenever possible, so that using the library does -**not** require advance knowledge of SDMX. +``pysdmx`` is a pragmatic and **opinionated** library written in Python. It +focuses on simplicity, providing a subset of SDMX functionalities without +requiring advanced knowledge of SDMX. -``pysdmx`` aims to be a versatile SDMX toolbox for Python and, -therefore, covers different use cases, a few of which are -highlighted below: +Key features: - **SDMX information model in Python**: ``pysdmx`` offers Python classes - representing a **simplified subset of the SDMX information model**, thereby - enabling a domain-driven development of SDMX processes in Python. The model + representing a **simplified subset of the SDMX information model**, + enabling a domain-driven development of SDMX processes with Python. These classes are serializable. -- **Metadata in action**: One of the main features of ``pysdmx`` is to - support retrieving metadata from a SDMX Registry (or any service compliant - with the SDMX-REST 2.0.0 API), so that you can use them to power statistical - processes. -- **Data discovery and data retrieval**: This functionality is **not - available yet** but is on the development roadmap. In a nutshell, ``pysdmx`` - will allow listing public SDMX services, discovering the data available in - these various services and retrieving data from these various services. +- **Metadata in action**: ``pysdmx`` supports retrieving metadata from a SDMX + Registry or any service compliant with the SDMX-REST 2.0.0 API. Use these + metadata to power statistical processes. +- **Data discovery and retrieval**: This functionality is under development. + ``pysdmx`` will enable listing public SDMX services, discovering available + data available, and retrieving data from these services. -``pysdmx`` is published to `PyPI `_ and can be -installed using your preferred option (``pip``, ``pipx``, ``poetry``, -etc.). +``pysdmx`` is available on `PyPI `_ and can be +installed using options such as pip, pipx, poetry, etc. -For additional information, please refer to the -`project documentation `_. \ No newline at end of file +For more details, check the `project documentation +`_. From d30471c004738aa83be91c121756eff1744350d0 Mon Sep 17 00:00:00 2001 From: Xavier Sosnovsky Date: Mon, 20 Nov 2023 16:40:18 +0100 Subject: [PATCH 4/4] Fix typo --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c4222fe..8938d29 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ Key features: representing a **simplified subset of the SDMX information model**, enabling a domain-driven development of SDMX processes with Python. These classes are serializable. -- **Metadata in action**: ``pysdmx`` supports retrieving metadata from a SDMX +- **Metadata in action**: ``pysdmx`` supports retrieving metadata from an SDMX Registry or any service compliant with the SDMX-REST 2.0.0 API. Use these metadata to power statistical processes. - **Data discovery and retrieval**: This functionality is under development.