Metadata-Version: 2.1
Name: soch-download
Version: 1.1.0
Summary: SOCH Download CLI lets you do multithreaded batch downloads of Swedish Open Cultural Heritage(K-samsök) records for offline processing and analytics.
Home-page: https://github.com/riksantikvarieambetet/SOCH-Download-CLI
Author: Albin Larsson
Author-email: albin.larsson@raa.se
License: MIT
Download-URL: https://github.com/riksantikvarieambetet/SOCH-Download-CLI/tarball/1.1.0
Keywords: SOCH,K-samsök,heritage,cultural,CLI
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: ksamsok
Requires-Dist: requests

# SOCH Download CLI

![screenshot](screenshot.gif)

SOCH Download CLI lets you do **multithreaded** batch downloads of Swedish Open Cultural Heritage (K-samsök) records for offline processing and analytics.

## Prerequirements

 - Python >=3.4 and PIP

## Installing

```bash
pip install soch-download
```

## Usage Examples

**Heads up: This program might use all the systems available CPUs.**

Download records based on a SOCH search query (Text, CQL, indexes, etc):

```bash
soch-download --action=query --query=thumbnailExists=j --outdir=path/to/target/directory
```

Download records from an specific institution:

```bash
soch-download --action=institution --institution=raa --outdir=path/to/target/directory
```

Download records using a predefined action/query:

```bash
soch-download --action=all --outdir=path/to/target/directory
soch-download --action=geodata-exists --outdir=path/to/target/directory
```

**Unpacking**

The download actions by default downloads large XML files containing up to 1000 RDFs each, after such a download you can use the `unpack` argument to convert all those files into individual RDF files:

```bash
soch-download --unpack=path/to/xml/files --outdir=path/to/target/directory
```

**Misc**

List all available parameters and actions:

```bash
soch-download --help
```

Target a custom SOCH API endpoint:

```bash
soch-download --action=query --query=itemKeyWord=hus --outdir=path/to/target/directory --endpoint=http://lx-ra-ksam2.raa.se:8080/
```


