Tools for working with a Fedora 4 repository.
Plastron is composed of several distribution packages:
- plastron-client: The Fedora repository API client
- plastron-rdf: RDF-to-Python property mapping
- plastron-models: Content models, CSV serialization
- plastron-repo: Repository operations and structural models (LDP, PCDM, Web Annotations, etc.)
- 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
- plastron-utils: 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.
Requires Python 3.8+
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 .venv
source .venv/bin/activate
pip install \
-e './plastron-utils[test]' \
-e './plastron-client[test]' \
-e './plastron-rdf[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).
Plastron uses the pytest test framework for its tests.
pytest
See the testing documentation for more information.
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.
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
See the LICENSE file for license rights and limitations (Apache 2.0).