Coyote

Build Status

An open source image annotation app enabling the distributed annotation and comprehensive representation of images. Long descriptions can range from one sentence to several paragraphs. The software was developed by the Museum of Contemporary Art Chicago to support a distributed workflow for describing their images and publishing those descriptions to the web.

Example

An image like this would traditionally be described by alt text like A red, white, and blue fabric canopy presses against walls of room; portable fans blow air into the room through a doorway.:

MCAChicago sample image T.Y.F.F.S.H

Kris Martin, Belgian, b. 1972. T.Y.F.F.S.H., 2011. Collection: Museum of Contemporary Art. Photo: Nathan Keay, © MCA Chicago.

Coyote aims to provide more comprehensive representations:

This is an installation that viewers are invited to walk inside of. From this viewpoint you are looking through a doorway at a slight distance, as if standing inside of a large cave and looking out of its narrow entrance at the world outside. The walls of this cave are alternating stripes of red, white, and blue material that seems to be made of some kind of thin fabric. These colored stripes spiral around toward the entrance, as if being sucked out of the opening. The inside of the cave is more shadowed and the area outside is brightly lit. Gradually you notice that there are in fact two openings lined up in front of each other, straight ahead of you: the first one is a tall rectangle—the red, white and blue fabric is wrapped through the edges of a standard doorway; beyond that it continues to spiral around toward another circular opening. The center of this circle is much brighter, as if one had finally escape from the cave. At the center of that circular opening you see two large white fans facing your direction, blowing air into the cave-like opening. Beyond the fans you see a brown, square form, which is the bottom of a huge wicker basket. This basket, lying on its side, helps to reveal the truth about what you are seeing: You are standing inside of a huge hot air balloon, which is lying on its side. Blown by the fans, the fabric billows out to press out against the existing w alls of a large room, the malleable shape of the balloon conforming to the rectangular surfaces of an existing building–the gallery that contains it.

More information about image description projects at the MCA and elsewhere is available at coyote.pics, along with contact information for the project team. You can also view or hear image descriptions on the MCA website.

Table of contents

Developer Setup

Beginning Developers

The app can run in a self-contained Docker container, which you can use for development. For more details see local development with Docker Compose.

1) Install Docker Community Edition

2) Run the following commands:

git clone https://github.com/coyote-team/coyote.git
cd coyote
docker-compose build   # downloads images, builds containers
docker-compose up      # start running containers
docker-compose up test # run the test suite
docker-compose exec web bin/rake db:setup db:migrate db:seed                    # prepare database, add seed data
docker-compose exec web bin/rake coyote:admin:create[user@example.com,password] # create initial user

3) Open http://localhost:3000 in your browser.

Once the app is running you can interact with it using commands like this:

docker ps                                   # list running containers
docker-compose build                        # rebuild web container when new gems are installed
docker-compose exec web pumactl restart     # restart Puma
docker-compose exec web bin/rails console   # access Rails console
docker-compose exec web bin/rake db:migrate # update the Postgres server managed by Docker

Experienced Developers

The app can also run in your local development environment, but requires a bit more know-how.

1) Install Postgres (on MacOS try Postgres.app).

2) Run the following commands:

git clone https://github.com/coyote-team/coyote.git
cd coyote
bin/setup
bin/rails server && open http://localhost:3000

The seed script builds a simple user, so you can login as admin@example.com.

We have setup a Guardfile to speed up development. Try bundle exec guard.

Testing Mailers in Development Mode

The settings in [sample.env] work with mailcatcher:

gem install mailcatcher     # runs independently of the app, so this gem is not part of our Gemfile
mailcatcher -f              # much better to run this in foreground vs. the default daemon mode
open http://127.0.0.1:1080/ # mail delivery console

Re-seeding the Database

You can regenerate development environment data by running bundle exec rake dev_only:reseed.

Development Workflow

Topic Branches & Review Apps

We use Heroku Pipelines and a modified "git flow" workflow for our development process. It's very important you follow the process outlined below!

  1. Create a topic branch off of master related to your work, typically something like
   git checkout master
   git checkout -b {name}/{issue-numer}-{description} # (e.g.) `flip/208-fix-dev-workflow

  1. Write your code and then run tests, either locally (guard or rspec) or via CI (simply push your topic branch to Github: git push origin flip/208-fix-dev-workflow)

  2. When CI has run on Github, create a pull request ("PR") and request a review from one or more team members who aren't you

  3. Heroku will deploy a review app for every pull request you create. The review apps automatically generate seed data to use with testing. Reviewers can use them to test new functionality with one of the seed user accounts.

Deploying to Staging

Deploying to staging happens automatically whenever the master branch is modified (in this, master is similar to develop in git flow). Staging is available at staging.coyote.pics.

IMPORTANT NOTE: when you deploy to staging, the production database is cloned and then migrations are run on staging. This means every commit to master will overwrite the staging database.

Deploying to Production

Deploying to production is as simple as merging master into production. Doing this will automatically deploy your code and run migrations TO THE PRODUCTION INSTANCE, so be 100% sure you know what you're doing and test a lot on staging first.

Documentation

YARD documentation is hosted at coyote-team.github.io.

Fresh documentation can be generated locally by running bundle exec rake coyote:docs OUT=docs/apipie. The OUT parameter is for apipie.

Coyote design refinements are documented in design_refinements.pdf.

API

Coyote's API is based on the JSON API standard. Coyote-specific JSON API documentation is generated by apipie and can be viewed here.

Strategies

We can extend the functionality of Coyote to better integrate with your particular CMS with a strategy file. For an example, check out /lib/coyote/strategies/mca.rb.

Links

More info regarding accessibility:

Contributors

License

MPLv2