Add scripts that use ArchivesSnake

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+docstring-convention = google
+ignore =
+	D100 # Missing docstring in public module
+	D101 # Missing docstring in public class
+	D102 # Missing docstring in public method
+	D103 # Missing docstring in public function
+	D104 # Missing docstring in public package
+	D105 # Missing docstring in magic method
+	D106 # Missing docstring in public nested class
+	D107 # Missing docstring in __init__
+	E501 # Line too long

.gitignore

@@ -1,3 +1,7 @@
+.DS_store
 **/secrets.py
 **/secretsDev.py
 **/config.ini
+local_settings.cfg
+__pycache__
+.coverage

archivessnake/.flake8

@@ -0,0 +1,12 @@
+[flake8]
+docstring-convention = google
+ignore =
+	D100 # Missing docstring in public module
+	D101 # Missing docstring in public class
+	D102 # Missing docstring in public method
+	D103 # Missing docstring in public function
+	D104 # Missing docstring in public package
+	D105 # Missing docstring in magic method
+	D106 # Missing docstring in public nested class
+	D107 # Missing docstring in __init__
+	E501 # Line too long

archivessnake/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+- repo: https://github.com/ambv/black
+  rev: 22.6.0
+  hooks:
+  - id: black
+    args: [--safe, --quiet]
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+  - id: flake8
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+    args: [--profile, black]
+- repo: https://github.com/jazzband/pip-tools
+  rev: 6.8.0
+  hooks:
+    - id: pip-compile

archivessnake/README.md

@@ -0,0 +1,21 @@
+# archivessnake
+
+These scripts use ArchivesSnake to export data from and push data to ArchivesSpace.
+
+## Requirements
+
+* See requirements.txt
+
+## Installation
+
+These scripts require a local configurations file, which should be created in the same directory as the script and named `local_settings.cfg`. A sample file looks like this:
+
+```
+    [ArchivesSpace]
+    # the base URL of your ArchivesSpace installation
+    baseURL:http://localhost:8089
+    username:admin
+    password:admin
+```
+
+

archivessnake/fixtures/ao_with_date.json

@@ -0,0 +1,111 @@
+{
+	"lock_version": 0,
+	"position": 8232,
+	"publish": true,
+	"ref_id": "cef33b4d44f5f58ad7903cd74f0ba7f8",
+	"title": "R--Miscellaneous",
+	"display_string": "R--Miscellaneous, 1982-1984",
+	"restrictions_apply": false,
+	"created_by": "admin",
+	"last_modified_by": "admin",
+	"create_time": "2019-05-21T16:28:20Z",
+	"system_mtime": "2023-03-20T15:14:05Z",
+	"user_mtime": "2019-05-21T16:28:20Z",
+	"suppressed": false,
+	"is_slug_auto": false,
+	"level": "file",
+	"jsonmodel_type": "archival_object",
+	"external_ids": [
+
+	],
+	"subjects": [
+
+	],
+	"linked_events": [
+
+	],
+	"extents": [
+
+	],
+	"lang_materials": [
+
+	],
+	"dates": [
+		{
+			"lock_version": 0,
+			"expression": "1982-1984",
+			"created_by": "admin",
+			"last_modified_by": "admin",
+			"create_time": "2019-05-21T16:28:20Z",
+			"system_mtime": "2019-05-21T16:28:20Z",
+			"user_mtime": "2019-05-21T16:28:20Z",
+			"date_type": "inclusive",
+			"label": "creation",
+			"jsonmodel_type": "date"
+		}
+	],
+	"external_documents": [
+
+	],
+	"rights_statements": [
+
+	],
+	"linked_agents": [
+
+	],
+	"import_previous_arks": [
+
+	],
+	"ancestors": [
+		{
+			"ref": "/repositories/2/archival_objects/181601",
+			"level": "series"
+		},
+		{
+			"ref": "/repositories/2/resources/5189",
+			"level": "collection"
+		}
+	],
+	"instances": [
+		{
+			"lock_version": 0,
+			"created_by": "admin",
+			"last_modified_by": "admin",
+			"create_time": "2019-05-21T16:28:20Z",
+			"system_mtime": "2019-05-21T16:28:20Z",
+			"user_mtime": "2019-05-21T16:28:20Z",
+			"instance_type": "box",
+			"jsonmodel_type": "instance",
+			"is_representative": false,
+			"sub_container": {
+				"lock_version": 0,
+				"created_by": "admin",
+				"last_modified_by": "admin",
+				"create_time": "2019-05-21T16:28:20Z",
+				"system_mtime": "2019-05-21T16:28:20Z",
+				"user_mtime": "2019-05-21T16:28:20Z",
+				"jsonmodel_type": "sub_container",
+				"top_container": {
+					"ref": "/repositories/2/top_containers/19221"
+				}
+			}
+		}
+	],
+	"notes": [
+
+	],
+	"accession_links": [
+
+	],
+	"uri": "/repositories/2/archival_objects/190075",
+	"repository": {
+		"ref": "/repositories/2"
+	},
+	"resource": {
+		"ref": "/repositories/2/resources/5189"
+	},
+	"parent": {
+		"ref": "/repositories/2/archival_objects/181601"
+	},
+	"has_unpublished_ancestor": false
+}

archivessnake/fixtures/ao_without_date.json

@@ -0,0 +1,100 @@
+{
+	"lock_version": 0,
+	"position": 5698,
+	"publish": true,
+	"ref_id": "ad234bcda4de58dfaa180aab442e91c3",
+	"title": "Gray, Sanford D.",
+	"display_string": "Gray, Sanford D.",
+	"restrictions_apply": false,
+	"created_by": "admin",
+	"last_modified_by": "admin",
+	"create_time": "2019-05-21T16:27:48Z",
+	"system_mtime": "2023-03-20T15:14:05Z",
+	"user_mtime": "2019-05-21T16:27:48Z",
+	"suppressed": false,
+	"is_slug_auto": false,
+	"level": "file",
+	"jsonmodel_type": "archival_object",
+	"external_ids": [
+
+	],
+	"subjects": [
+
+	],
+	"linked_events": [
+
+	],
+	"extents": [
+
+	],
+	"lang_materials": [
+
+	],
+	"dates": [
+
+	],
+	"external_documents": [
+
+	],
+	"rights_statements": [
+
+	],
+	"linked_agents": [
+
+	],
+	"import_previous_arks": [
+
+	],
+	"ancestors": [
+		{
+			"ref": "/repositories/2/archival_objects/181601",
+			"level": "series"
+		},
+		{
+			"ref": "/repositories/2/resources/5189",
+			"level": "collection"
+		}
+	],
+	"instances": [
+		{
+			"lock_version": 0,
+			"created_by": "admin",
+			"last_modified_by": "admin",
+			"create_time": "2019-05-21T16:27:48Z",
+			"system_mtime": "2019-05-21T16:27:48Z",
+			"user_mtime": "2019-05-21T16:27:48Z",
+			"instance_type": "box",
+			"jsonmodel_type": "instance",
+			"is_representative": false,
+			"sub_container": {
+				"lock_version": 0,
+				"created_by": "admin",
+				"last_modified_by": "admin",
+				"create_time": "2019-05-21T16:27:48Z",
+				"system_mtime": "2019-05-21T16:27:48Z",
+				"user_mtime": "2019-05-21T16:27:48Z",
+				"jsonmodel_type": "sub_container",
+				"top_container": {
+					"ref": "/repositories/2/top_containers/18853"
+				}
+			}
+		}
+	],
+	"notes": [
+
+	],
+	"accession_links": [
+
+	],
+	"uri": "/repositories/2/archival_objects/187541",
+	"repository": {
+		"ref": "/repositories/2"
+	},
+	"resource": {
+		"ref": "/repositories/2/resources/5189"
+	},
+	"parent": {
+		"ref": "/repositories/2/archival_objects/181601"
+	},
+	"has_unpublished_ancestor": false
+}