gem-packaged commands for processing aperitiiif batches 🥂
- aperitiiif : documentation for the project; publishes to github pages
- aperitiiif-batch-template : template repository for creating batches; includes github actions workflows, gem configs, and project scaffolding.
It is highly recommended that you use the aperitiiif-batch-template repo to create your new batch project. This method will include all the necessary Ruby dependencies and project structure.
Alternatively, you can add the gem to your project's Gemfile:
gem 'aperitiiif', github: 'nyu-dss/aperitiiif-cli'Then install by running the command:
bundle installAfter your batch project is set up and you have installed the dependencies using Bundler, you will have access to the aperitiiif commands.
- Check available commands
bundle exec aperitiiif --help- Check available batch commands
bundle exec aperitiiif batch --helpYou will see something like:
➜ bundle exec aperitiiif batch --help
Commands:
aperitiiif batch build # build batch resources
aperitiiif batch help [COMMAND] # Describe subcommands or one specific subc...
aperitiiif batch lint # lint the batch
aperitiiif batch reset # reset the batchContributions should:
- Avoid code smells
- Follow style guide
- Update tests as needed
- Update documentation as needed
To ensure the above, this repo includes configuration for reek and rubocop as well as rspec tests. You can run them respectively with the following commands:
bundle exec reekbundle exec rubocop -Abundle exec rspec