Skip to main content

Object mapping library for manipulating RDF graphs that are compliant with the OpenCitations datamodel.

Project description

oc_ocdm

Run tests Coverage Documentation Status PyPI version PyPI

DOI License: ISC

Documentation can be found here: https://oc-ocdm.readthedocs.io.

oc_ocdm is a Python ≥3.7 library that enables the user to import, produce, modify and export RDF data structures which are compliant with the OCDM v2.0.1 specification.

User's guide

This package can be simply installed with pip:

    pip install oc_ocdm

Please, have a look at the notebooks available here.

Developer's guide

First steps

  1. Install Poetry:
    pip install poetry
  1. Clone this repository:
    git clone https://github.com/iosonopersia/oc_ocdm
    cd ./oc_ocdm
  1. Install all the dependencies:
    poetry install
  1. Build the package (output dir: dist):
    poetry build
  1. Globally install the package (alternatively, you can also install it inside a virtual-env, by providing the full path to the .tar.gz archive):
    pip install ./dist/oc_ocdm-<VERSION>.tar.gz
  1. If everything went the right way, than you should be able to use the oc_ocdm library in your Python modules as follows:
    from oc_ocdm.graph import GraphSet
    from oc_ocdm.graph.entities.bibliographic import AgentRole
    # ...

How to run the tests

Just run the following command inside the root project folder:

    poetry run test

How to manage the project using Poetry

See Poetry commands documentation.

AAA: when adding a non-dev dependency via poetry add, always remember to add that same dependency to the autodoc_mock_imports list in docs/source/conf.py (otherwise "Read the Docs" won't be able to compile the documentation correctly!).

How to publish the package onto Pypi

    poetry publish --build

Install dependencies needed for the documentation

    pip install Sphinx sphinx_rtd_theme

How to generate the documentation

    rm ./docs/source/modules/*
    sphinx-apidoc  -o ./docs/source/modules oc_ocdm *test*

How to build the documentation


Warning! In order to avoid getting the following WARNING: html_static_path entry '_static' does not exist, you'll need to manually create an empty _static folder with the command:

    mkdir docs/source/_static

  1. Always remember to move inside the docs folder:
    cd docs
  1. Use the Makefile provided to build the docs:
    • on Windows
          make.bat html
      
    • on Linux and MacOs
          make html
      
  2. Open the build/html/index.html file with a web browser of your choice!

Citation

If you are using or extending oc_ocdm as part of a scientific publication, we would appreciate a citation of our article.

@inproceedings{persiani2022programming,
  title={{A} {P}rogramming {I}nterface for {C}reating {D}ata {A}ccording to the {SPAR} {O}ntologies and the {O}pen{C}itations {D}ata {M}odel},
  author={Persiani, Simone and Daquino, Marilena and Peroni, Silvio},
  booktitle={The Semantic Web: 19th International Conference, ESWC 2022, Hersonissos, Crete, Greece, May 29--June 2, 2022, Proceedings},
  pages={305--322},
  year={2022},
  organization={Springer}
}

Acknowledgements

This work has been funded by the project “Open Biomedical Citations in Context Corpus” (Wellcome Trust, Grant n. 214471/Z/18/Z) and the project “Wikipedia Citations in Wikidata” (Wikimedia Foundation, https://meta.wikimedia.org/wiki/Wikicite/grant/Wikipedia_Citations_in_Wikidata).

We would like to thank (in alphabetic order) Fabio Mariani (@FabioMariani), Arcangelo Massari (@arcangelo7), and Gabriele Pisciotta (@GabrielePisciotta) for the constructive feedback.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oc_ocdm-9.2.0.tar.gz (92.7 kB view details)

Uploaded Source

Built Distribution

oc_ocdm-9.2.0-py3-none-any.whl (178.2 kB view details)

Uploaded Python 3

File details

Details for the file oc_ocdm-9.2.0.tar.gz.

File metadata

  • Download URL: oc_ocdm-9.2.0.tar.gz
  • Upload date:
  • Size: 92.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.2 Linux/6.1.0-25-amd64

File hashes

Hashes for oc_ocdm-9.2.0.tar.gz
Algorithm Hash digest
SHA256 6f99b0601f51da856476f0278957051a22d6b88bcb8e81f98c4eac80c7f9d5a3
MD5 8408f54ed11c094c09da5b1305aed73a
BLAKE2b-256 42284311e400388fef1bd126dc98925a35d3198545fc5d330e651ac5f389134b

See more details on using hashes here.

File details

Details for the file oc_ocdm-9.2.0-py3-none-any.whl.

File metadata

  • Download URL: oc_ocdm-9.2.0-py3-none-any.whl
  • Upload date:
  • Size: 178.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.2 Linux/6.1.0-25-amd64

File hashes

Hashes for oc_ocdm-9.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bcffb65f613a950dc0649cc6a2cb81e2ac3132432bf7a0eb70c26d6c3c2bf6cf
MD5 bf455ad1dfb3c997fddd5777da7f29e7
BLAKE2b-256 d218cc6f405203bbd5da74203ca2dce896a47bf02df70dca9444177e505de4fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page