From 4c7fb8a4d5a8c9725a7e31c3c8ebd2b5ef6d77f8 Mon Sep 17 00:00:00 2001 From: dombean <46692370+dombean@users.noreply.github.com> Date: Mon, 30 Sep 2024 10:50:53 +0100 Subject: [PATCH 1/3] Fix docstring for test_load_json_with_encoding() in test_s3_utils.py (#122) --- CHANGELOG.md | 1 + tests/cdp/helpers/test_s3_utils.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5da8320..3e03e33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0 ### Added ### Changed +- Fix docstring for `test_load_json_with_encoding` in `test_s3_utils.py`. ### Deprecated diff --git a/tests/cdp/helpers/test_s3_utils.py b/tests/cdp/helpers/test_s3_utils.py index d5b0fe0..63df967 100644 --- a/tests/cdp/helpers/test_s3_utils.py +++ b/tests/cdp/helpers/test_s3_utils.py @@ -1035,7 +1035,7 @@ def test_load_json_invalid_json(self, s3_client): load_json(s3_client, "test-bucket", "invalid.json") def test_load_json_with_encoding(self, s3_client): - """Test read_json with a specific encoding.""" + """Test load_json with a specific encoding.""" data = {"name": "John", "age": 30, "city": "Manchester"} # Convert the dictionary to JSON string and encode it in 'utf-16' From 83477fb0e143cfb124e53eaf0d6eba2cb8dc2ed6 Mon Sep 17 00:00:00 2001 From: dombean <46692370+dombean@users.noreply.github.com> Date: Fri, 4 Oct 2024 21:51:33 +0100 Subject: [PATCH 2/3] Add section to README.md (#123) --- CHANGELOG.md | 1 + README.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e03e33..e0bd6c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0 ### Added ### Changed +- Added "How the Project is Organised" section to `README.md`. - Fix docstring for `test_load_json_with_encoding` in `test_s3_utils.py`. ### Deprecated diff --git a/README.md b/README.md index c79c3ce..8b997b6 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,25 @@ To install via `pip`, simply run: pip install rdsa-utils ``` +## 🗂️ How the Project is Organised + +The `rdsa-utils` package is designed to make it easy to work with different platforms like Cloudera Data Platform (CDP) and Google Cloud Platform (GCP), as well as handle general Python tasks. Here's a breakdown of how everything is organised: + +- **General Utilities (Top-Level)**: + - These are tools you can use for any project, regardless of the platform you're working on. They focus on common Python, PySpark, and Pandas tasks. + - 📂 **Helpers**: Handy functions that simplify working with Python and PySpark. + - 📂 **IO**: Functions for handling input and output, like reading configurations or saving results. + +- **Platform-Specific Utilities**: + - **CDP (Cloudera Data Platform)**: + - 📂 **Helpers**: Functions that help you work with tools supported by CDP, such as HDFS, Impala, and AWS S3. + - 📂 **IO**: Input/output functions specifically for CDP, such as managing data and logs in CDP environments. + - **GCP (Google Cloud Platform)**: + - 📂 **Helpers**: Functions to help you interact with GCP tools like Google Cloud Storage and BigQuery. + - 📂 **IO**: Input/output functions for managing data with GCP services. + +This structure keeps the tools for each platform separate, so you can easily find what you need, whether you're working in a cloud environment or on general Python tasks. + ## 📖 Documentation and Further Information Our documentation is automatically generated using **GitHub Actions** and **MkDocs**. For an in-depth understanding of `rdsa-utils`, how to contribute to `rdsa-utils`, and more, please refer to our [MkDocs-generated documentation](https://onsdigital.github.io/rdsa-utils/). From 3bcc24410a6bc642d4ea894ec1e93d7cbed4c2ba Mon Sep 17 00:00:00 2001 From: dombean <46692370+dombean@users.noreply.github.com> Date: Fri, 4 Oct 2024 21:54:25 +0100 Subject: [PATCH 3/3] Release v0.3.5 --- .bumpversion.cfg | 2 +- CHANGELOG.md | 14 ++++++++++++++ rdsa_utils/__init__.py | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 219f5bf..fe19f1f 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.3.4 +current_version = 0.3.5 commit = False tag = False parse = (?P\d+)\.(?P\d+)\.(?P\d+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e0bd6c2..a7d1de2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,18 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0 ### Added +### Changed + +### Deprecated + +### Fixed + +### Removed + +## [v0.3.5] - 2024-10-04 + +### Added + ### Changed - Added "How the Project is Organised" section to `README.md`. - Fix docstring for `test_load_json_with_encoding` in `test_s3_utils.py`. @@ -408,6 +420,8 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0 > and GitHub Releases. +- rdsa-utils v0.3.5: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.3.5) | + [PyPI](https://pypi.org/project/rdsa-utils/0.3.5/) - rdsa-utils v0.3.4: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.3.4) | [PyPI](https://pypi.org/project/rdsa-utils/0.3.4/) - rdsa-utils v0.3.3: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.3.3) | diff --git a/rdsa_utils/__init__.py b/rdsa_utils/__init__.py index 334b899..a8d4557 100644 --- a/rdsa_utils/__init__.py +++ b/rdsa_utils/__init__.py @@ -1 +1 @@ -__version__ = "0.3.4" +__version__ = "0.3.5"