https://github.com/psu-libraries/etda_utilities

Common methods used by etda_workflow and etda_explore
https://github.com/psu-libraries/etda_utilities

Last synced: 4 days ago
JSON representation

Common methods used by etda_workflow and etda_explore

• Host: GitHub
• URL: https://github.com/psu-libraries/etda_utilities
• Owner: psu-libraries
• License: mit
• Created: 2017-10-06T14:22:11.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T18:31:30.000Z (23 days ago)
• Last Synced: 2024-10-31T13:55:36.863Z (20 days ago)
• Language: Ruby
• Homepage:
• Size: 109 KB
• Stars: 0
• Watchers: 10
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# EtdaUtilities

![CI](https://github.com/psu-libraries/etda_utilities/actions/workflows/ruby-ci.yml/badge.svg)

Common methods used by etda_workflow and etda_explore

## Installation

This Gem isn't published, so you'll have to install it straight from GitHub.  It is a public repository, so no private key/token is necessary.

To install via git, add this line to your applications's Gemfile:

```ruby

gem 'etda_utilities', git: "https://github.com/psu-stewardship/etda_utilities.git", branch: 'master'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install etda_utilities

## Usage

TODO: Write usage instructions here

## Development

To run in ruby console:

`irb -Ilib -retda_utilities`

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/[USERNAME]/etda_utilities. 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 EtdaUtilities project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/psu-stewardship/etda_utilities/blob/master/CODE_OF_CONDUCT.md).