Skip to content

e-plus-healthcare-alliance/aristotle-metadata-registry

 
 

Repository files navigation

Aristotle MetaData Registry (Aristotle-MDR)

build status Documentation Status Code coverage on coveralls visit the live demonstration server on PythonAnywhere

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.

Aristotle-MDR 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 independant 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

Aristotle-MDR aims to be compliant to the core model described within ISO/IEC 11179, however a number of extensions are available to extend functionality and add additional content types.

Quick start

  1. Add "aristotle_mdr" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (
        ...
        'haystack',
        'aristotle_mdr',
        'grappelli',
        ...
    )

    To ensure that search indexing works properly haystack must be installed before aristotle_mdr. If you want to take advantage of Aristotle's access-key shortcut improvements for the admin interface, make sure it is installed before grappelli.

  2. Include the Aristotle-MDR URLconf in your project urls.py. Because Aristotle will form the majority of the interactions with the site, and the Aristotle includes a number of URLconfs for supporting apps its recommended to included it at the server root, like this:

    url(r'^/', include('aristotle_mdr.urls')),
  3. Run python manage.py migrate to create the Aristotle-MDR Database.
  4. Install lessc for your system (eg. apt-get install node-less) or configure django-static-precompiler to use your LESS pre-processor of choice. (This step is not required if you are running from PythonAnywhere)
  5. (Optional) Compile the multilingual resource files for improved performance, like so:

    django-admin.py compilemessages
  6. Start the development server and visit http://127.0.0.1:8000/ to see the home page.

For a complete example of how to successfully include Aristotle, see the tests/settings.py settings file.

A live Aristotle-MDR instance is available for review on PythonAnywhere at: http://aristotle.pythonanywhere.com/. Be aware, this is an active development instance and may sporadically be unavailble.

Screenshots for users

More screenshots available in the Aristotle-MDR Wiki.

A newly created data element. The newly created Data Element

An item being without changing screens Edit screen for a Data Element

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" or reviewing the documentation and wiki and identifying (and even adding) content that isn't there.

About the badges (plus some extras):

  • build status - Travis-CI, showing the details of the continuous testing suite
  • Documentation Status - Rad the docs, with details on installing, configuring and extending Aristotle-MDR
  • Code coverage on coveralls - Coveralls, showing in-depth code coverage
  • Code coverage on code cov (includes branch checks) - Codecov.io, showing even more in-depther code coverage with branch coverage
  • visit the live demonstration server on PythonAnywhere - A link to a live demo and development server
  • visit the gitter chat room for this project - Gitter, a git-powered chat room for developers

About

Aristotle-MDR is an open-source metadata registry as laid out by the requirements of the ISO/IEC 11179 specification.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 58.0%
  • HTML 38.9%
  • CSS 2.2%
  • JavaScript 0.9%