=====================================
Aristotle Metadata Registry Mono-repo
=====================================
|aristotle-logo|
|actions-python| |actions-javascript| |docs| |coveralls| |demoserver| |codeclimate| |wcagzoo|
Introduction and mission statement
----------------------------------
Aristotle-MDR is an open-source metadata registry as laid out by the requirements
of the `ISO/IEC 11179:2013 specification <http://metadata-standards.org/11179/>`_.
The Aristotle Metadata Registry represents a new way to manage and federate content built on and extending
the principles of leading metadata registries. The code of Aristotle is completely open-source,
building on the Django web framework and the mature model of the 11179 standard, allowing
agencies to easily run their own metadata registries while also having the ability
to extend the information model and tap into the permissions and roles of ISO 11179.
By allowing organisations to run their own independent registries they are able to
expose authoritative metadata along with the governance processes behind its creation,
and by building upon known and open systems agencies, can deliver a stable platform
for the sharing of metadata.
Extensions
++++++++++
The core of the Aristotle Metadata Registry is designed to conform to the models
described within ISO/IEC 11179-3,
However this mono-repo includes a number of standards-based extensions that
provide additional functionality or new metadata types.
Screenshots for users
---------------------
`More screenshots available in the Aristotle Metadata Registry User Help Documentation <http://help.aristotlemetadata.com/>`_.
A data element shown on desktop and mobile
|homescreenshot|
An item being edited without changing screens
|itemeditsample|
Information for developers
--------------------------
Aristotle-MDR is free open-source software and contributions are welcome on front-end web development,
back-end server development, translation and content creation (such as more documentation).
Review the wiki, open issues and existing documentation to get started.
**If you are looking to contribute**, `a good place to start is checking out the open issues labeled "help wanted" <https://github.com/aristotle-mdr/aristotle-metadata-registry/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22>`_
or reviewing the `documentation <http://docs.aristotlemetadata.com/>`_ and `wiki <https://github.com/aristotle-mdr/aristotle-metadata-registry/wiki>`_ and identifying (and even adding) content that isn't there.
About the badges (plus some extras):
++++++++++++++++++++++++++++++++++++
* |actions-python| - Github actions, showing the details of the python continuous testing suite
* |actions-javascript| - Github actions, showing the details of the javascript continuous testing suite
* |docs| - Read the docs, with details on installing, configuring and extending Aristotle-MDR
* |coveralls| - Coveralls, showing in-depth code coverage
* |codecov| - Codecov.io, showing even greater in-depth code coverage with branch coverage
* |demoserver| - A link to a live open-metadata registry
* |gitter| - Gitter, a git-powered chat room for developers
* |codeclimate| - Code Climate - additional code metrics
* |wcagzoo| - Web Content Accessibility Guidelines AA Compliant
.. |actions-python| image:: https://github.com/aristotle-mdr/aristotle-metadata-registry/workflows/Python/badge.svg
:alt: Github actions python workflow
:scale: 100%
:target: https://travis-ci.org/aristotle-mdr/aristotle-metadata-registry
.. |actions-javascript| image:: https://github.com/aristotle-mdr/aristotle-metadata-registry/workflows/JavaScript/badge.svg
:alt: Github actions javascript workflow
:scale: 100%
:target: https://travis-ci.org/aristotle-mdr/aristotle-metadata-registry
.. |docs| image:: https://readthedocs.org/projects/aristotle-metadata-registry/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://readthedocs.org/projects/aristotle-metadata-registry/
.. |coveralls| image:: https://coveralls.io/repos/github/aristotle-mdr/aristotle-metadata-registry/badge.svg?branch=master
:alt: Code coverage on coveralls
:scale: 100%
:target: https://coveralls.io/r/aristotle-mdr/aristotle-metadata-registry?branch=master
.. |codecov| image:: https://codecov.io/github/aristotle-mdr/aristotle-metadata-registry/coverage.svg?branch=master
:alt: Code coverage on code cov (includes branch checks)
:scale: 100%
:target: https://codecov.io/github/aristotle-mdr/aristotle-metadata-registry?branch=master
.. |demoserver| image:: https://img.shields.io/badge/Open_Metadata_Registry-online-blue.svg
:alt: visit the open access metadata registry
:scale: 98%
:target: https://registry.aristotlemetadata.com
.. |gitter| image:: https://badges.gitter.im/Join%20Chat.svg
:alt: visit the gitter chat room for this project
:scale: 100%
:target: https://gitter.im/LegoStormtroopr/aristotle-metadata-registry?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
.. |codeclimate| image:: https://codeclimate.com/github/aristotle-mdr/aristotle-metadata-registry/badges/gpa.svg
:target: https://codeclimate.com/github/aristotle-mdr/aristotle-metadata-registry
:alt: Code Climate
.. |wcagzoo| image:: https://img.shields.io/badge/WCAG_Zoo-AA-green.svg
:target: https://github.com/data61/wcag-zoo/wiki/Compliance-Statement
:alt: This repository is WCAG-Zoo compliant
.. |homescreenshot| image:: ./docs/_static/homescreenshot.png
:alt: Main screen of the Aristotle registry
:scale: 100%
.. |itemeditsample| image:: ./docs/_static/itemeditsample.png
:alt: Edit screen for a metadata object
:scale: 100%
.. |aristotle-logo| image:: ./python/aristotle-metadata-registry/aristotle_mdr/static/aristotle_mdr/images/aristotle.png
:alt: Aristotle-MDR Logo
:scale: 100%
:target: http://www.aristotlemetadata.com