Sha256: ae439101590638eca1013ee645810bd1c3fd902e19021a88ee904f3f1309c890

Contents?: true

Size: 1.65 KB

Versions: 11

Compression:

Stored size: 1.65 KB

Contents

[![Build Status](https://travis-ci.org/datacite/maltese.svg?branch=master)](https://travis-ci.org/datacite/maltese)
[![Code Climate](https://codeclimate.com/github/datacite/maltese/badges/gpa.svg)](https://codeclimate.com/github/datacite/maltese)
[![Test Coverage](https://codeclimate.com/github/datacite/maltese/badges/coverage.svg)](https://codeclimate.com/github/datacite/maltese/coverage)

# Maltese

Ruby gem and command-line tool for generating sitemap files from the DataCite REST API. Uses the [SitemapGenerator](https://github.com/kjvarga/sitemap_generator) gem and can be run as Docker container, e.g. using ECS and triggered by AWS Lambda, as described [here](https://medium.com/@pahud/ecs-task-runner-with-lambda-4594b72ccb#.5xpmf2inz).

Run as a command-line tool:

```
maltese sitemap --from_date 2017-02-15
```

## Installation

Requires Ruby 2.2 or later. Then add the following to your `Gemfile` to install the
latest version:

```ruby
gem 'maltese'
```

Then run `bundle install` to install into your environment.

You can also install the gem system-wide in the usual way:

```bash
gem install maltese
```

## Development

We use rspec for unit testing:

```
bundle exec rspec
```

Follow along via [Github Issues](https://github.com/datacite/toccatore/issues).

### Note on Patches/Pull Requests

* Fork the project
* Write tests for your new feature or a test that reproduces a bug
* Implement your feature or make a bug fix
* Do not mess with Rakefile, version or history
* Commit, push and make a pull request. Bonus points for topical branches.

## License
**maltese** is released under the [MIT License](https://github.com/datacite/maltese/blob/master/LICENSE.md).

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
maltese-0.2.4 README.md
maltese-0.2.2 README.md
maltese-0.2 README.md
maltese-0.1.9 README.md
maltese-0.1.8 README.md
maltese-0.1.7 README.md
maltese-0.1.6 README.md
maltese-0.1.5 README.md
maltese-0.1.4 README.md
maltese-0.1.3 README.md
maltese-0.1.2 README.md