Installation Instructions¶

Note

The below instruction is for the testing phase use only.

To install the U of T Dataverse Curation Tool on a Windows local machine, follow the steps below:

Prerequisites¶

Steps¶

First, install the prerequisites if you haven't already. from the links provided above.
Remember to select the option 'Git Credential Manager' during Git installation.
If the tool's GitHub repository remains private, you will need to request access from Ken. Authenticate with Github using the Git Credential Manager when prompted.
Clone the repository to your local machine using the in a PowerShell terminal:
```
git clone https://github.com/kenlhlui/pydatacuration-p.git
```
Navigate to the cloned repository:
```
 cd pydatacuration-p
```
Make a directory called 'workdir' for the tool to use as a workspace:
```
mkdir workdir
```
Install the required dependencies using uv:
```
uv sync
```

Open the project in VS Code and create a .env file in the root directory. Populate it with the required environment variables, referring to app_settings.py. For faster testing, you may also include default values from setup_form.py. :

 # App Settings
 app_title='U of T Dataverse Curation Tool'
 log_level='DEBUG'

 # Default values for setup form (for faster testing)
 base_url='https://borealisdata.ca/'
 api_token='YOUR_API_TOKEN'
 curator_name='YOUR_NAME'
 curator_email='YOUR_EMAIL'
 collection_alias='toronto' # The alias for U of T Dataverse collection on Borealis

Run the application using uv:
```
uv run --env-file .env app.py
```

Access the tool¶

You should be able to access the tool at http://localhost:9005 in your web browser.

Close the application¶

To close the application, simply press Ctrl + C in the PowerShell terminal.

API Token security tip

A best security practice is revoke the API Token in Borealis after you are done using the tool. You can generate a new API token for the next time you use the tool.

Next steps¶

Go to the testing page for the testing instructions.