Merge pull request #124 from ONSdigital/development

Release 0.3.5

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.4
+current_version = 0.3.5
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)

CHANGELOG.md

@@ -17,6 +17,20 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 
 ### 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`.
+
+### Deprecated
+
+### Fixed
+
+### Removed
+
 ## [v0.3.4] - 2024-09-30
 
 ### Added
@@ -406,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) | 

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/).

rdsa_utils/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.3.5"

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'