Skip to content

Commit 3b1a47a

Browse files
authored
Update README.md
1 parent 1c5786f commit 3b1a47a

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Retrieves 'begin,' 'end,' 'expression,' and 'date_type' for all dates associated
2020
Based on a specified file name and a specified file path, extracts selected elements from an EAD XML file and prints them to a CSV file.
2121

2222
#### [getAccessionUDFs.py](/getAccessionUDFs.py)
23-
This GET script retrieves all of the user-defined fields from all of the accessions in the specified repository.
23+
Retrieves all of the user-defined fields from all of the accessions in the specified repository.
2424

2525
#### [getAccessions.py](/getAccessions.py)
26-
This GET script retrieves all of the accessions from a particular repository into a JSON file.
26+
Retrieves all of the accessions from a particular repository into a JSON file.
2727

2828
#### [getAllArchivalObjectTitles.py](/getAllArchivalObjectTitles.py)
2929
Retrieves titles from all archival objects in a repository. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
@@ -32,19 +32,19 @@ Retrieves titles from all archival objects in a repository. Upon running the scr
3232
Retrieves a count of archival objects associated with a particular resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
3333

3434
#### [getArchivalObjectsByResource.py](/getArchivalObjectsByResource.py)
35-
A GET script to extract all of the archival objects associated with a particular resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
35+
Extracts all of the archival objects associated with a particular resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
3636

3737
#### [getArrayPropertiesFromAgentsPeopleCSV.py](/getArrayPropertiesFromAgentsPeopleCSV.py)
38-
This GET script retrieves specific properties, including proprerties that have arrays as values, from the JSON of ArchivesSpace agent_people records. In this example, the 'dates_of existence' property contains an array that must be iterated over. This requires a second level of iteration with 'for j in range (...)' on line 20, which is in addition to the iteration function 'for i in range (...)' on line 19, which was also found in the getPropertiesFromAgentsPeopleCSV.py script. As with the previous script, it also writes the properties' values into a CSV file which is specified in variable 'f' on line 17.
38+
Retrieves specific properties, including proprerties that have arrays as values, from the JSON of ArchivesSpace agent_people records. In this example, the 'dates_of existence' property contains an array that must be iterated over. This requires a second level of iteration with 'for j in range (...)' on line 20, which is in addition to the iteration function 'for i in range (...)' on line 19, which was also found in the getPropertiesFromAgentsPeopleCSV.py script. As with the previous script, it also writes the properties' values into a CSV file which is specified in variable 'f' on line 17.
3939

4040
#### [getPropertiesFromAgentsPeopleCSV.py](/getPropertiesFromAgentsPeopleCSV.py)
41-
This GET script 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.
41+
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
#### [getResources.py](/getResources.py)
44-
This GET scripts 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').
44+
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').
4545

4646
#### [getSingleRecord.py](/getSingleRecord.py)
47-
Based on user input, this GET script retrieves a single ArchivesSpace record based on the specified record's 'uri.'
47+
Based on user input, retrieves a single ArchivesSpace record based on the specified record's 'uri.'
4848

4949
#### [getTopContainerCountByResource.py](/getTopContainerCountByResource.py)
5050
Retrieves a count of top containers associated with archival objects associated with a particular resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
@@ -53,19 +53,19 @@ Retrieves a count of top containers associated with archival objects associated
5353
Retrieves a count of top containers directly associated (not through an archival object) with a particular resource. Upon running the script, you will be prompted enter the resource ID (just the number, not the full URI).
5454

5555
#### [getTopContainers.py](/getTopContainers.py)
56-
This GET script retrieves all of the top containers from a particular repository into a JSON file.
56+
Retrieves all of the top containers from a particular repository into a JSON file.
5757

5858
#### [getUrisAndIds.py](getUrisAndIds.py)
59-
For the specified record type, this script retrieves URI and the 'id_0,' 'id_1,' 'id_2,' 'id_3,' and a concatenated version of all the 'id' fields.
59+
For the specified record type, retrieves URI and the 'id_0,' 'id_1,' 'id_2,' 'id_3,' and a concatenated version of all the 'id' fields.
6060

6161
#### [postContainersFromCSV.py](/postContainersFromCSV.py)
62-
This script works to create 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.
62+
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.
6363

6464
#### [postNew.py](/postNew.py)
65-
This POST script will post 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.
65+
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.
6666

6767
#### [postOverwrite.py](/postOverwrite.py)
68-
This POST script will overwrite 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.
68+
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.
6969

7070
#### [resourcesWithNoBibNum.py](/resourcesWithNoBibNum.py)
7171
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.
@@ -74,7 +74,7 @@ Prints the URIs to a CSV file of all resources in a repository without a bib num
7474
Prints the URIs to a CSV file of all top containers that are not associated with a resource or archival object.
7575

7676
#### [unpublishArchivalObjectsByResource.py](/unpublishArchivalObjectsByResource.py)
77-
This script 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).
77+
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).
7878

7979
#### [updateFindingAidData.py](/updateFindingAidData.py)
8080

0 commit comments

Comments
 (0)