Plastron

Tools for working with a Fedora 4 repository.

Architecture

Plastron is composed of several distribution packages, arranged in three layers:

Applications

• plastron-cli: Command-line tool. Also includes the handler classes for the load command
• plastron-stomp: STOMP daemon for handling asynchronous operations
• plastron-web: Web application for handling synchronous operations

High-Level APIs

• plastron-models: Content models, CSV serialization
• plastron-repo: Repository operations and structural models (LDP, PCDM, Web Annotations, etc.)

Low-level APIs

• plastron-client: The Fedora repository API client
• plastron-messaging: STOMP message models and message broker connection handling
• plastron-rdf: RDF-to-Python property mapping
• plastron-utils: Namespace definitions and miscellaneous utilities

The intent is that these distribution packages are independently useful, either as tools that can be run or libraries to be included in other projects.

Installation

Requires Python 3.8+

To install just the API libraries (low- and high-level):

pip install plastron

To install the applications as well:

# individually
pip install 'plastron[cli]'
pip install 'plastron[stomp]'
pip install 'plastron[web]'

# all together
pip install 'plastron[cli,stomp,web]'

Running

• Command-line client
• STOMP daemon
• HTTP webapp

Development

This repository includes a .python-version file. If you are using a tool like pyenv to manage your Python versions, it will select an installed Python 3.8 for you.

To install Plastron in development mode, do the following:

git clone git@github.com:umd-lib/plastron.git
cd plastron
python -m venv --prompt "plastron-py$(cat .python-version)" .venv
source .venv/bin/activate
pip install \
    -e './plastron-utils[test]' \
    -e './plastron-client[test]' \
    -e './plastron-rdf[test]' \
    -e './plastron-messaging[test]' \
    -e './plastron-models[test]' \
    -e './plastron-repo[test]' \
    -e './plastron-web[test]' \
    -e './plastron-stomp[test]' \
    -e './plastron-cli[test]'

This allows for in-place editing of Plastron's source code in the git repository (i.e., it is not locked away in a Python site-packages directory structure).

Testing

Plastron uses the pytest test framework for its tests.

pytest

See the testing documentation for more information.

API Documentation

To generate API documentation from the code, use pdoc:

pip install pdoc

To use the built-in, live-reloading web server to generate and browse the documentation, use:

pdoc plastron

The generated HTML documentation will be available at http://localhost:8080/plastron.html.

Name

The plastron is the nearly flat part of the shell structure of a turtle, what one would call the belly or ventral surface of the shell.

Source: Wikipedia

License

See the LICENSE file for license rights and limitations (Apache 2.0).