https://github.com/tulibraries/oai_index
https://github.com/tulibraries/oai_index
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tulibraries/oai_index
- Owner: tulibraries
- License: mit
- Created: 2019-11-25T13:59:29.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T18:35:53.000Z (5 months ago)
- Last Synced: 2026-01-29T08:59:02.954Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 274 KB
- Stars: 0
- Watchers: 4
- 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
# OaiIndex
[](https://travis-ci.org/tulibraries/oai_index)
[](https://coveralls.io/github/tulibraries/oai_index?branch=main)
Oai Index is a repository to hold the traject configuration files and scripts
associated with indexing for dpla oai server.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'oai_index'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install oai_index
## Usage
`oai_index` is an executable. You can use it to ingest files into SOLR_URL with
```
oai_index ingest $path_to_file
```
`$path_file` can also be a URL.
### Ingest switches
`--commit` If this switch is passed (`oai_index ingest --commit`), then oai_index will send commit at end of ingest process.
## 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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tulibraries/oai_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 CobIndex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tulibraries/oai_index/blob/main/CODE_OF_CONDUCT.md).