Skip to content

tulibraries/cob_az_index

Repository files navigation

TUL A-Z databases indexing (cob_az_index)

Build Status Coverage Status

cob_az_index is a repository that holds the Traject configuration files and scripts associated with the indexing of Springshare A-Z database records for Temple University Libraries' Library Search (tul_cob).

Installation

Add this line to your application's Gemfile:

gem 'cob_az_index'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cob_az_index

Usage

cob_az_index is an executable. You can use it to ingest files into SOLR_AZ_URL with

cob_az_index ingest $path_to_file

$path_to_file can also be a URL.

Note also that $path_to_file is an optional argument. If not provided then by default ingest will attempt to download a copy of the AZ db and import that file.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Ingest Fixture Files

cob_az_index ingest --use-fixtures

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tulibraries/cob_az_index. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the CobAzIndex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published