Skip to content

Commit 7e976cd

Browse files
committed
creating personal access token guide
1 parent 72e21be commit 7e976cd

File tree

1 file changed

+35
-17
lines changed

1 file changed

+35
-17
lines changed

README.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ This program executes four main tasks:
1111
2. Downloading the .zip file for the full data project to the Original Deposit folder and an unzipped version to QDR Prepared for further Curation
1212
3. Creating github issues for standard curation tasks and associating them with a github Project for the curation of the data project.
1313
4. Automatically setting metadata for PDF files based on Dataverse metadata
14-
5. Anoynymizing PDFs by stripping the beginning of filenames and metadata
1514

1615
# Installing dvcurator-python
1716

@@ -31,22 +30,41 @@ Some functions, like downloading public datasets, will operate without API token
3130

3231
# Tokens
3332

34-
To be fully functional, the following parameters must be set:
35-
* A **project DOI** in the form `doi:10.1234/abcdef`. Once metadata is loaded for that DOI, use the "Reset dvcurator" button to input a different DOI.
36-
* A **github token**
37-
* To create a github token, go to your github developer settings/personal access tokens at https://github.com/settings/tokens
38-
* Click on "Generate New Token", and select "Generate New Token (classic)"
39-
* Give the token a recognizable name such as "QDR Curation" and check the following boxes:
40-
* repo
41-
* admin:org
42-
* project
43-
* Click "Generate Token" at the bottom of the screen. Make sure to note down your token and keep it safe (you won't be able to access this later)
44-
* A **dataverse API key** -- this must be for the dataverse installation you will work with.
45-
* Find or create this under https://data.qdr.syr.edu/dataverseuser.xhtml?selectTab=apiTokenTab (substitute the domain if not using QDR)
46-
47-
Both of these tokens are entered on into the main window of dvcurator, under "Github token" and "Dataverse token" respectively.
48-
49-
Other parameters are:
33+
## Creating a Dataverse API key
34+
- This must be for the dataverse installation you will work with.
35+
- Find or create this under https://data.qdr.syr.edu/dataverseuser.xhtml?selectTab=apiTokenTab (substitute the domain if not using QDR)
36+
37+
## Creating a Fine-Grained GitHub Personal Access Token
38+
39+
1. Go to your GitHub account settings
40+
- Click your profile photo in the top right
41+
- Select **Settings**
42+
43+
2. Navigate to Developer settings
44+
- Scroll to the bottom of the left sidebar
45+
- Click **Developer settings**
46+
- Select **Personal access tokens**
47+
- Click **Fine-grained tokens**
48+
- Click **Generate new token**
49+
50+
3. Configure token settings
51+
- Give your token a descriptive name (e.g., "DVCurator Access")
52+
- Choose "QualitativeDataRepository" as the resource owner
53+
- Select the repository "Project-Curation"
54+
- Under "Repository permissions", enable:
55+
- [x] **Actions** (Read and write)
56+
- Needed for triggering workflow dispatches
57+
- [x] **Issues** (Read)
58+
- Needed for checking existing tickets, to make sure we don't create duplicates
59+
60+
4. Generate and save the token
61+
- Click **Request** at the bottom and ask the admin to approve
62+
- **IMPORTANT**: Copy and save the token immediately
63+
64+
5. Using the token
65+
- In DVCurator, paste the token in the GitHub token field (under "DVCurator -> Configure Tokens")
66+
67+
# Other parameters
5068
- QDR GA folder: Where the archive will be downloaded and extracted to. Usually points to a folder that syncs with Dropbox, but does not necessarily need to be. For QDR GA's this should very literally be the "QDR GA" folder within the QDR Dropbox.
5169

5270
## For developers (i.e. not most users!)

0 commit comments

Comments
 (0)