Merge pull request #18 from ResearchObject/prepare-release

Rename repository and prepare release

Author: elichad

README.md

@@ -1,5 +1,76 @@
-# ro-crate-uploader
-RO-Crate uploader for Zenodo
+# ro-crate-zenodo
 
-[User Guide](docs/user_guide.md)
-[Developer Guide](docs/developer_guide.md)
+Upload RO-Crates to Zenodo and automatically fill the Zenodo metadata.
+
+This package uses the legacy Zenodo API and is not compatible with other InvenioRDM instances. For RO-Crate uploads using the InvenioRDM API, use the [rocrate-invenio](https://github.com/ResearchObject/ro-crates-deposit) package instead.
+
+## Setup
+
+### Install the package
+
+Install from PyPI using `pip` or your preferred package manager:
+```
+pip install rocrate-zenodo
+```
+### Set up a Zenodo personal access token
+
+Create a file called `~/.config/zenodo.ini` on your computer with the following contents:
+
+```ini
+# if using the Zenodo sandbox
+[zenodo:sandbox]
+sandbox_api_token = 
+
+# if using the real Zenodo
+[zenodo]
+api_token = 
+```
+
+Now create a Zenodo access token:
+
+1. Register for a Zenodo account if you don’t already have one.
+1. Go to your profile and select Applications.
+1. You should see a section called "Personal access tokens." Click the "New token" button.
+1. Give the token a name that reminds you of what you're using it for (e.g. _RO-Crate uploader token_)
+1. Select the scopes `deposit:write` and `deposit:actions`.
+1. Click "Create."
+1. Copy the access token into your `~/.config/zenodo.ini` file.
+
+The resulting file should look like this:
+
+```ini
+# if using the Zenodo sandbox
+[zenodo:sandbox]
+sandbox_api_token = your-sandbox-token-here
+
+# if using the real Zenodo
+[zenodo]
+api_token = your-token-here
+```
+
+The `rocrate-zenodo` package 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 the package.
+
+## Usage
+
+To upload a crate to Zenodo sandbox:
+```
+rocrate_zenodo -s demo/demo_crate
+```
+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.
+
+For further help and options, run:
+```
+rocrate_zenodo --help
+```
+
+## Tips
+
+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-zenodo/issues/new) if you notice a discrepancy.
+
+## For Developers
+
+See the [Developer Guide](docs/developer_guide.md).

docs/developer_guide.md

@@ -9,6 +9,7 @@ If you do not already have `poetry` installed, install it following the [Poetry
 Then install dependencies from `poetry.lock`:
 
 ```bash
+cd ro-crate-zenodo
 poetry install
 ```
 
@@ -29,3 +30,11 @@ In the root directory:
 ```bash
 pytest
 ```
+
+## Publish a release
+
+1. Update the version in `pyproject.toml`
+2. Make a git tag for the release and push it to GitHub
+3. Run `poetry build`
+4. Run `poetry publish -u <username> -p <password_or_api_key>`
+5. Create a release on GitHub, including the build artifacts

docs/user_guide.md

@@ -8,12 +8,15 @@ build-backend = "poetry.core.masonry.api"
 name = "rocrate-zenodo"
 version = "0.1.0"
 description = "Upload RO-Crates to Zenodo and automatically fill the Zenodo metadata"
-authors = ["Eli Chadwick <eli.chadwick@manchester.ac.uk>"]
+authors = [
+  "Eli Chadwick <eli.chadwick@manchester.ac.uk>",
+  "Stian Soiland-Reyes <soiland-reyes@manchester.ac.uk>",
+]
 maintainers = ["Eli Chadwick <eli.chadwick@manchester.ac.uk>"]
 license = "Apache-2.0"
 readme = "README.md"
 homepage = "https://www.researchobject.org/ro-crate/"
-repository = "https://github.com/ResearchObject/ro-crate-uploader"
+repository = "https://github.com/ResearchObject/ro-crate-zenodo"
 keywords = ["rocrate", "RO-Crate"]
 classifiers = [
   "Development Status :: 3 - Alpha",
@@ -44,7 +47,7 @@ rocrate_zenodo = "rocrate_zenodo.main:cli_entry"
 my_package_cli = 'my_package.console:run'
 
 [tool.poetry.urls]
-"Issues" = "https://github.com/ResearchObject/ro-crate-uploader/issues"
+"Issues" = "https://github.com/ResearchObject/ro-crate-zenodo/issues"
 
 # Testing tools
 

pyproject.toml

@@ -114,7 +114,7 @@ def upload_crate_to_zenodo(
     res = create_zenodo(
         # this is a unique key you pick that will be used to store
         # the numeric deposition ID on your local system's cache
-        # key="ro-crate-uploader",
+        # key="ro-crate-zenodo",
         data=metadata,
         paths=[
             crate_zip_path,