Skip to content

Commit 0c7c870

Browse files
authored
Update README.md
1 parent ef2608d commit 0c7c870

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,10 @@ Retrieves specific properties, including proprerties that have arrays as values,
4141
Retrieves specific properties from the JSON of ArchivesSpace agent_people records into a CSV file which is specified in variable 'f' on line 17. In this example, the script retrieves the 'uri,' 'sort_name,' 'authority_id,' and 'names' properties from the JSON records by iterating through the JSON records with the function 'for i in range (...)' on line 19. The f.writerow(....) function on line 20 specifies which properties are retrieved from the JSON and the f.writerow(....) on line 18 specifies header row of the CSV file.
4242

4343
#### [getPropertiesFromResources.py](/getPropertiesFromResources.py)
44+
Extracts select properties from all resources in the repository.
4445

4546
#### [getPropertiesFromSingleResource.py](/getPropertiesFromSingleResource.py)
47+
Based on user input, extracts select properties from the specified resource.
4648

4749
#### [getResources.py](/getResources.py)
4850
Retrieves all of the resources from a particular repository into a JSON file which is specified in variable 'f' on line 16. This GET script can be adapted to other record types by editing the 'endpoint' variable on line 13 (e.g. 'repositories/[repo ID]/accessions' or 'agents/corporate_entities').
@@ -66,10 +68,13 @@ For the specified record type, retrieves URI and the 'id_0,' 'id_1,' 'id_2,' 'id
6668
Creates instances (consisting of top_containers) from a separate CSV file. The CSV file should have two columns, indicator and barcode. The directory where this file is stored must match the directory in the filePath variable. The script will prompt you first for the exact name of the CSV file, and then for the exact resource or accession to attach the containers to.
6769

6870
#### [postContainersToRecords.py](/postContainersToRecords.py)
71+
Based on user input, posts containers to a specified record based on a specified CSV file.
6972

7073
#### [postCorporateAgentsFromCSV.py](/postCorporateAgentsFromCSV.py)
74+
Based on user input, posts corporate agents based on a specified CSV file.
7175

7276
#### [postFamilyAgentsFromCSV.py](/postFamilyAgentsFromCSV.py)
77+
Based on user input, posts family agents based on a specified CSV file.
7378

7479
#### [postNew.py](/postNew.py)
7580
Posts new records to a generic API endpoint based the record type, 'agents/people' in this example. This script can be modified to accommodate other data types (e.g. 'repositories/[repo ID]/resources' or 'agents/corporate_entities'). It requires a properly formatted JSON file (specified where [JSON File] appears in the 'records' variable on line 13) for the particular ArchivesSpace record type you are trying to post.
@@ -78,10 +83,13 @@ Posts new records to a generic API endpoint based the record type, 'agents/peopl
7883
Overwrites existing ArchivesSpace records based the 'uri' and can be used with any ArchivesSpace record type (e.g. resource, accession, subject, agent_people, agent_corporate_entity, archival_object, etc.). It requires a properly formatted JSON file (specified where [JSON File] appears in the 'records' variable on line 13) for the particular ArchivesSpace record type you are trying to post.
7984

8085
#### [postPeopleAgentsFromCSV.py](/postPeopleAgentsFromCSV.py)
86+
Based on user input, posts people agents based on a specified CSV file.
8187

8288
#### [postSubjectsFromCSV.py](/postSubjectsFromCSV.py)
89+
Based on user input, posts subjects based on a specified CSV file.
8390

8491
#### [resourcesWithBibNum.py](/resourcesWithBibNum.py)
92+
Extracts URIs of resources with bib numbers in the user-defined 'real_1' field.
8593

8694
#### [resourcesWithNoBibNum.py](/resourcesWithNoBibNum.py)
8795
Prints the URIs to a CSV file of all resources in a repository without a bib number stored in the ['user_defined']['real_1'] field.
@@ -93,5 +101,4 @@ Prints the URIs to a CSV file of all top containers that are not associated with
93101
Unpublishes all archival objects associated with the specified resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
94102

95103
#### [updateResourceWithAgentOrSubjectLinks.py](/updateResourceWithAgentOrSubjectLinks.py)
96-
97-
#### [updateResourceWithCSV.py](/updateResourceWithCSV.py)
104+
Based on user input, posts agent or subject links to resources based on a specified CSV file.

0 commit comments

Comments
 (0)