args-me-model 0.3.0

Data model for the args.me argument search engine

# args-me-model

[![PyPI - Version](https://img.shields.io/pypi/v/args-me-model)](https://pypi.org/project/args-me-model/)
[![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fwebis-de%2Fargs-me-model%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)](https://webis.de/args-me-model)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/webis-de/args-me-model/test.yml)](https://github.com/webis-de/args-me-model/actions/workflows/test.yml)
[![Static Badge](https://img.shields.io/badge/licence-MIT-%2395c30d)](https://github.com/webis-de/args-me-model/blob/main/LICENSE)


The data model of the args.me search engine (work-in-progress).


[Claim](https://github.com/webis-de/args-me-model/blob/main/src/args_me_model/claim.py)s are extracted from or generated by one or more [Source](https://github.com/webis-de/args-me-model/blob/main/src/args_me_model/source.py)s and connected via [Support](https://github.com/webis-de/args-me-model/blob/main/src/args_me_model/support.py) relations. Two claims can reference each other as their `counter` if they state the opposite of each other.


## Install
```shell
pip install args-me-model
```


## Quickstart
```python
from args_me_model import Claim, Source

# Creating claims
claim1 = Claim.from_source(
        Source(
            name="common-knowledge",
            text="Blue is scattered more than other colors"
        )
    )
claim2 = Claim.from_source(
        Source(
            name="common-knowledge",
            text="The sky is blue"
        ),
        support = [[claim1]] # list of linked support
    )
claim3 = Claim.from_source(
        Source(
            name="uncommon-knowledge",
            text="The sky is not blue"
        ),
        counter = claim2 # claim2 and claim3 are counter claims
    )

# Writing claims to a file
Claim.write_ndjson([claim1, claim2, claim3], "myclaim.ndjson")

# Iterating over claims from a file
for claim in Claim.read_ndjson("myclaim.ndjson"):
    print(claim.text)
```

More information in the [documentation](https://webis.de/args-me-model).

## Development
Running unittests (done automatically on push)
```shell
PYTHONPATH=$PWD/src python3 -m unittest
```

Building documentation (done automatically on release)
```shell
pip install -r docs/requirements
sphinx-build -b html docs/ docs/_build
```