https://github.com/tulibraries/cob_az_index
https://github.com/tulibraries/cob_az_index
dataops librarysearch
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tulibraries/cob_az_index
- Owner: tulibraries
- License: mit
- Created: 2019-06-26T21:03:53.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-10-21T20:17:49.000Z (5 months ago)
- Last Synced: 2025-10-21T22:17:01.293Z (5 months ago)
- Topics: dataops, librarysearch
- Language: Ruby
- Homepage:
- Size: 637 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TUL A-Z databases indexing (cob_az_index)
[](https://travis-ci.org/tulibraries/cob_az_index)
[](https://coveralls.io/github/tulibraries/cob_az_index?branch=main)
**cob_az_index** is a repository that holds the [Traject](https://github.com/traject/traject) configuration files and scripts
associated with the indexing of Springshare A-Z database records for Temple University Libraries' Library Search ([tul_cob](https://github.com/tulibraries/tul_cob)).
## Installation
Add this line to your application's Gemfile:
```ruby
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](https://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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/tulibraries/cob_az_index/blob/main/CODE_OF_CONDUCT.md).