astopy/panoptes repository overview

⁠Panoptes

The new Zooniverse API for supporting user-created projects.

⁠Documentation

The Panoptes public API is documented here⁠, using apiary.io⁠.

If you're interested in how Panoptes is implemented check out the wiki⁠ and the Data Model Description⁠.

⁠Requirements

Since Panoptes uses Docker to manage its environment, the requirements listed below are also found in docker-compose.yml. The means by which a new Panoptes instance is created with Docker is located in the Dockerfile. If you plan on using Docker to manage Panoptes, skip ahead to Installation.

Panoptes is primarily developed against stable MRI, currently 2.3. If you're running MRI Ruby you'll need to have the Postgresql client libraries installed as well as have Postgresql⁠ version 9.4 running.

• Ubuntu/Debian: apt-get install libpq-dev
• OS X (with homebrew⁠): brew install postgresql

Optionally, you can also run the following:

• Cellect Server⁠ version > 0.1.0
• Redis⁠ version > 2.8.19

⁠Installation

We only support running Panoptes via Docker and Docker Compose. If you'd like to run it outside a container, see the above Requirements sections to get started.

It's possible to run Panoptes only having to install the fig_rake gem. Alternatives to various rake tasks are presented.

⁠Setup Docker and Docker Compose

• Docker

  • OS X⁠ - Docker Machine
  • Ubuntu⁠ - Docker
  • Windows⁠ - Boot2Docker

• Docker Compose⁠

⁠Usage

1. Clone the repository git clone https://github.com/zooniverse/Panoptes.

2. cd into the cloned folder.

3. Copy the example configuration files.

• Run: find config/*.yml.hudson -exec bash -c 'for x; do x=${x#./}; cp -i "$x" "${x/.hudson/}"; done' _ {} +

1. Install Docker from the appropriate link above.

2. • If you have an existing Panoptes Docker container, or if your Gemfile or Ruby version has changed, run docker-compose build to rebuild the containers.
   • Otherwise, create and run the application containers by running docker-compose up

3. After step 5 finishes, open a new terminal and run docker-compose run --rm --entrypoint=rake panoptes db:setup to setup the database. This will launch a new Docker container, run the rake DB setup task, and then clean up the container.

4. To seed the development database with an Admin user and a Doorkeeper client application for API access run docker-compose run --rm --entrypoint=rails panoptes runner db/fig_dev_seed_data/fig_dev_seed_data.rb

5. Open up the application in your browser:

• It should be running on http://localhost:3000⁠

• If it's not and you're on a Mac, run docker ps, and find the IP address where the panoptes_panoptes image is running. E.g.: 0.0.0.0:3000->3000/tcp means running on localhost at port 3000.

  Copy

CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 1f98164914be panoptes_panoptes "/bin/sh -c /rails_ap" 16 minutes ago Up 16 minutes 80/tcp, 0.0.0.0:3000->3000/tcp panoptes_panoptes_1 ```

This will get you a working copy of the checked out code base. Keep your code up to date and rebuild the image if needed!

⁠Testing

There are multiple options for setting up a testing environment:

1. Run it entirely from within docker-compose:

   1. To create the testing database, run docker-compose run --rm -e RAILS_ENV=test --entrypoint=rake panoptes db:setup.
   2. Run the full spec suite docker-compose run -T --rm -e RAILS_ENV=test --entrypoint=rspec panoptes. Note: this will be slow. Use rspec focus set or specify the spec you want to run, e.g. ``docker-compose run -T --rm -e RAILS_ENV=test --entrypoint="rspec path/to/spec/file.rb" panoptes`

2. Use parts of docker-compose manually and wire them up manually to create a testing environment.

   docker-compose run -d --name postgres --service-ports postgres
   docker-compose run -T --rm -e RAILS_ENV=test --entrypoint="bundle exec rspec" panoptes
   

   Copy

3. Assuming you have a Ruby environment already setup:

   1. Run bundle install
   2. Start the docker Postgres container by running docker-compose run -d --name postgres --service-ports postgres
   3. Modify your config/database.yml test env to point to the running Postgres container, e.g. host: localhost
   4. Setup the testing database if you haven't already, by running RAILS_ENV=test rake db:setup
   5. Finally, run rspec with RAILS_ENV=test rspec

⁠Contributing

Thanks a bunch for wanting to help Zooniverse. Here are few quick guidelines to start working on our project:

1. Fork the Project on Github.
2. Clone the code and follow one of the above guides to setup a dev environment.
3. Create a new git branch and make your changes.
4. Make sure the tests still pass by running bundle exec rspec.
5. Add tests if you introduced new functionality.
6. Commit your changes. Try to make your commit message informative⁠, but we're not sticklers about it. Do try to to add Closes #issue or Fixes #issue somewhere in your message if it's addressing a specific open issue.
7. Submit a Pull Request
8. Wait for feedback or a merge!

Your Pull Request will run on travis-ci⁠, and we'll probably wait for it to pass on MRI Ruby 2.3. For more information, see the wiki⁠.

⁠License

Copyright 2014-2016 by the Zooniverse

Distributed under the Apache Public License v2. See LICENSE