Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.83 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.83 KB
Raw

Parliament::NTriple

parliament-ntriple is a gem created by the Parliamentary Digital Service to allow processing of n-triple data from parliamentary APIs. This gem is effectively an extension of our parliament-ruby gem.

NOTE: This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.

Requirements

parliament-ntriple requires the following:

Installation

gem 'parliament-ntriple'

Usage

This gem's main function is to process n-triple data from parliamentary APIs.

Note: Comprehensive class documentation can be found on rubydocs.

Getting Started with Development

To clone the repository and set up the dependencies, run the following:

git clone https://github.com/ukparliament/parliament-ntriple.git
cd parliament-ntriple
bundle install

Running the tests

We use RSpec as our testing framework and tests can be run using:

bundle exec rake

Contributing

If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

  1. Fork the repository
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Ensure your changes are tested using Rspec
  6. Create a new Pull Request