Merge pull request #17 from ResearchObject/prepare-release

Move build system to poetry and prepare for release

Author: elichad

.github/workflows/lint.yml

@@ -21,17 +21,19 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
+      - name: Install poetry
+        run: |
+          sudo apt install -y pipx
+          pipx install poetry
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+          poetry install
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names
-          flake8 ./src/rocrate_upload --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 .B/src/rocrate_upload --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+          poetry run flake8 ./src/rocrate_zenodo --count --select=E9,F63,F7,F82 --show-source --statistics
+          # The GitHub editor is 127 chars wide
+          poetry run flake8 ./src/rocrate_zenodo --count --max-complexity=10 --max-line-length=127 --statistics
       - name: Lint with black
         run: |
-          black --check --diff .
+          poetry run black --check --diff .

.github/workflows/test.yml

@@ -25,14 +25,16 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Install poetry
+      run: |
+        sudo apt install -y pipx
+        pipx install poetry
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+        poetry install
     - name: Lint with mypy
       run: |
-        mypy .
+        poetry run mypy .
     - name: Test with pytest
       run: |
-        pytest
+        poetry run pytest

demo/demo.py

@@ -1,6 +1,6 @@
 from rocrate.rocrate import ROCrate
 
-from rocrate_upload.upload import (
+from rocrate_zenodo.upload import (
     build_zenodo_metadata_from_crate,
     ensure_crate_zipped,
     upload_crate_to_zenodo,

docs/developer_guide.md

@@ -1,21 +1,29 @@
-# Developer Guide - Under Construction
+# Developer Guide
 
 ## Environment
 
-Install dependencies:
+### Poetry setup
 
+If you do not already have `poetry` installed, install it following the [Poetry installation documentation](https://python-poetry.org/docs/#installation).
+
+Then install dependencies from `poetry.lock`:
+
+```bash
+poetry install
+```
+
+Activate the virtual environment:
 ```bash
-# general dependencies
-pip install -r requirements.txt
-# dev dependencies
-pip install -r requirements-dev.txt
+poetry shell
 ```
 
+### Zenodo access token setup
+
 Configure Zenodo access token(s) as in [user guide - Set up a Zenodo personal access token](user_guide.md#set-up-a-zenodo-personal-access-token).
 
 ## Run tests
 
-Beware that tests may make Zenodo uploads using your access token.
+Beware that tests can make Zenodo uploads using your access token.
 
 In the root directory:
 ```bash

docs/user_guide.md

@@ -1,15 +1,14 @@
-# User Guide - Under Construction
+# User Guide
 
-## Install the project
+## Setup
 
+### Install the package
+
+Install from PyPI using `pip` or your preferred package manager:
 ```
-git clone https://github.com/ResearchObject/ro-crate-uploader.git
-cd ro-crate-uploader
-pip install -r requirements.txt
-pip install .
+pip install rocrate_zenodo
 ```
-
-## Set up a Zenodo personal access token
+### Set up a Zenodo personal access token
 
 Create a file called `~/.config/zenodo.ini` on your computer with the following contents:
 
@@ -47,23 +46,23 @@ api_token = your-token-here
 
 `ro-crate-uploader` will read this token whenever it connects to Zenodo in order to perform actions under your account. It's recommended to use the Zenodo sandbox until you're confident using `ro-crate-uploader`.
 
-## Run the code
+## Usage
 
-Run the `rocrate_upload` command in your terminal. Use the `-s` flag to upload to Zenodo sandbox, or omit it to upload to real Zenodo.
+To upload a crate to Zenodo sandbox:
 ```
-rocrate_upload -s demo/demo_crate
+rocrate_zenodo -s demo/demo_crate
 ```
-Replace `demo/demo_crate` with the path to the RO-Crate directory you want to upload.
+Replace `demo/demo_crate` with the path to the RO-Crate directory you want to upload. The `-s` flag sets the destination to the Zenodo sandbox; you can omit `-s` to upload to real Zenodo.
 
 Once complete, you should see the draft record in your Zenodo dashboard.
 
-Further info:
+For further help and options, run:
 ```
-rocrate_upload --help
+rocrate_zenodo --help
 ```
 
 ## Tips
 
-1. Set `givenName` and `familyName` on authors of the RO-Crate.
-2. Use the SPDX URI for the top-level license, e.g. `https://spdx.org/licenses/CC-BY-NC-SA-4.0.html`
-3. Check your upload carefully before publishing.
+1. Set `givenName` and `familyName` on authors of the RO-Crate. This ensures that author names are formatted correctly in Zenodo.
+2. Use the SPDX URI for the top-level license, e.g. `https://spdx.org/licenses/CC-BY-NC-SA-4.0.html`. Other URIs for licenses are not currently well supported.
+3. Check your upload carefully in the Zenodo web interface before publishing. Not all metadata will be carried across from the RO-Crate, and some may be transferred incorrectly. Please [raise an issue](https://github.com/ResearchObject/ro-crate-uploader/issues/new) if you notice a discrepancy.