Merge pull request #2 from the-library-code/main

merge 0.1.13

Author: mdwRepository

.github/workflows/pylint.yml

@@ -0,0 +1,29 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py') --ignore-paths=^tests/.*$ --output=lint_${{ matrix.python-version }}.txt || true
+    - name: Upload Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: lint_${{ matrix.python-version }}.txt
+        path: lint_${{ matrix.python-version }}.txt

.pylintrc

@@ -0,0 +1 @@
+[MAIN]

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+### 0.1.13
+
+Date: 2024-12-11
+
+PyPI release page: https://pypi.org/project/dspace-rest-client/0.1.13/
+
+**Changes**
+
+1. Update requests and pysolr dependencies and improve setup.py (thanks @alanorth) https://github.com/the-library-code/dspace-rest-python/pull/24
+2. Add auto-paginating `get_*_iter` methods for most `get_*` methods (thanks @dpk) https://github.com/the-library-code/dspace-rest-python/pull/27
+3. Improve version number maintenance https://github.com/the-library-code/dspace-rest-python/pull/30
+4. New `create_item_version` method (thanks @soaringjupiter) https://github.com/the-library-code/dspace-rest-python/pull/31
+5. Allow `embed=['...', '...']` parameter in most methods that return objects, to allow embedded HAL resources https://github.com/the-library-code/dspace-rest-python/pull/20
+6. Extend `search_objects[_iter]` to accept a configuration parameter https://github.com/the-library-code/dspace-rest-python/pull/32
+7. Integrate pylint scaffolding (thanks @sszepe and @mdwRepository) https://github.com/the-library-code/dspace-rest-python/pull/37
+8. New `resolve_identifier_to_dso` method https://github.com/the-library-code/dspace-rest-python/pull/39
+9. Small pydoc improvements
+10. Added new example usage to `example.py`
+
 ### 0.1.12
 
 Date: 2024-08-06
@@ -10,6 +29,7 @@ PyPI release page: https://pypi.org/project/dspace-rest-client/0.1.12/
 
 1. Initialise search result objects as `SimpleDSpaceObject` rather than base `DSpaceObject` class (thanks to @JemmaPilcher)
 2. Introduce / tidy new `SearchResult` model as work towards https://github.com/the-library-code/dspace-rest-python/issues/17
+3. Fix `get_items` method parameters (thanks @ckubgi) https://github.com/the-library-code/dspace-rest-python/pull/21
 
 ### 0.1.11
 

console.py

@@ -1,28 +1,27 @@
+import code
+import os
+import sys
+
 from dspace_rest_client.client import DSpaceClient
 # Import models as needed
 #from dspace_rest_client.models import Community, Collection, Item, Bundle, Bitstream
-import code
-import os
 
-# The DSpace client will look for the same environment variables, but we can also look for them here explicitly
-# and as an example
-url = 'http://localhost:8080/server/api'
-if 'DSPACE_API_ENDPOINT' in os.environ:
-    url = os.environ['DSPACE_API_ENDPOINT']
-username = 'username@test.system.edu'
-if 'DSPACE_API_USERNAME' in os.environ:
-    username = os.environ['DSPACE_API_USERNAME']
-password = 'password'
-if 'DSPACE_API_PASSWORD' in os.environ:
-    password = os.environ['DSPACE_API_PASSWORD']
+DEFAULT_URL = 'http://localhost:8080/server/api'
+DEFAULT_USERNAME = 'username@test.system.edu'
+DEFAULT_PASSWORD = 'password'
+
+# Configuration from environment variables
+URL = os.environ.get('DSPACE_API_ENDPOINT', DEFAULT_URL)
+USERNAME = os.environ.get('DSPACE_API_USERNAME', DEFAULT_USERNAME)
+PASSWORD = os.environ.get('DSPACE_API_PASSWORD', DEFAULT_PASSWORD)
 
 # Instantiate DSpace client
-d = DSpaceClient(api_endpoint=url, username=username, password=password)
+d = DSpaceClient(api_endpoint=URL, username=USERNAME, password=PASSWORD)
 
 # Authenticate against the DSpace client
 authenticated = d.authenticate()
 if not authenticated:
-    print(f'Error logging in! Giving up.')
-    exit(1)
+    print('Error logging in! Giving up.')
+    sys.exit(1)
 
 code.interact(local=locals())

dspace_rest_client/__init__.py

@@ -1,2 +1,2 @@
 from . import *
-__version__ = '0.1.12'
+__version__ = '0.1.13'