Merge pull request #691 from facebookresearch/dev-1.0

Mephisto 1.0 Release PR

.github/workflows/npm-check.yml

@@ -0,0 +1,16 @@
+name: npm-check
+
+on:
+  pull_request_target:
+    branches: [main]
+
+jobs:
+  mephisto-task-latest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install Mephisto
+        run: pip install -e .
+      - name: Run version sync script
+        run: python scripts/check_npm_package_versions.py

.github/workflows/version-sync.yml

@@ -0,0 +1,17 @@
+name: version-sync
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  mephisto-task-version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install Mephisto
+        run: pip install -e .
+      - name: Run version sync script
+        run: python scripts/sync_mephisto_task.py check

.gitignore

@@ -13,6 +13,12 @@ mephisto/server/blueprints/**/build/*
 **/build/*
 **/_generated/*
 **/outputs/*
+mephisto/scripts/metrics/*
+!mephisto/scripts/metrics/resources
+!mephisto/scripts/metrics/install_*.sh
+!mephisto/scripts/metrics/README.md
+!mephisto/scripts/metrics/view_metrics.py
+!mephisto/scripts/metrics/shutdown_metrics.py
 .coverage
 
 # Examples

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+    rev: v4.1.0
     hooks:
       - id: trailing-whitespace
         exclude: |
@@ -14,12 +14,12 @@ repos:
       - id: check-added-large-files
         args: ["--maxkb=10000"]
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 22.1.0
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/prettier/pre-commit
-    rev: "v2.1.2"
+    rev: "57f39166b5a5a504d6808b87ab98d41ebf095b46"
     hooks:
       - id: prettier
         files: "\\.(\

.prettierignore

@@ -1,2 +1,3 @@
 *.md
 **/build/*
+docs/web/static/python_api/*

Dockerfile-frontend

@@ -0,0 +1,34 @@
+# Using the -slim version below for minimal size. You may want to
+# remove -slim, or switch to -alpine if encountering issues
+ARG BASE_TAG=python3.9-nodejs15-slim
+ARG BASE_IMAGE=nikolaik/python-nodejs:$BASE_TAG
+
+FROM $BASE_IMAGE
+
+# Storybook will be launched on this port:
+EXPOSE 6006
+
+COPY . /mephisto
+RUN mkdir ~/.mephisto
+
+WORKDIR /mephisto
+
+# The `open` package needs to be unplugged from yarn 2 ONLY for Linux
+# See more details here: https://github.com/yarnpkg/berry/issues/856
+RUN yarn unplug -AR open
+
+RUN yarn install
+RUN yarn build-all
+
+
+# Write the mephisto config file manually for now to avoid prompt.
+# For bash-style string $ expansion for newlines,
+# we need to switch the shell to bash:
+SHELL ["/bin/bash", "-c"]
+RUN echo $'core: \n  main_data_directory: /mephisto/data' >> ~/.mephisto/config.yml
+
+# Uncomment if you'd like to install the Mephisto CLI as well:
+# RUN cd /mephisto && ls && pip install -e .
+# RUN mephisto check # Run mephisto check so a mock requester gets created
+
+CMD yarn sb

MANIFEST.in

@@ -1,6 +1,11 @@
 include README.md
 include mephisto/VERSION
 include mephisto/__init__.py
+include mephisto/scripts/metrics/install_metrics.sh
+include mephisto/scripts/metrics/shutdown_metrics.py
+include mephisto/scripts/metrics/view_metrics.py
+include mephisto/scripts/metrics/README.md
+recursive-include mephisto scripts/metrics/resources/*
 recursive-include mephisto abstractions/**/*
 recursive-include mephisto client/**/*
 recursive-exclude mephisto **/__pycache__/**/*

README.md

@@ -9,9 +9,9 @@
 
 Mephisto makes crowdsourcing easier.
 
-We provide a platform for launching, monitoring, and reviewing your crowdsourcing tasks. Tasks made on Mephisto can easily be open sourced as part of other projects.
+We provide a platform for launching, monitoring, and reviewing your crowdsourcing tasks. Tasks made on Mephisto can easily be open sourced as part of other projects. Like the [chess-playing automaton](https://en.wikipedia.org/wiki/Mephisto_(automaton)) we've adopted the name from, Mephisto hides the complexity of projects that need human interaction or input.
 
-As of now we're in an early alpha release, more details to come. See our in-progress docs at [mephisto.ai](https://mephisto.ai).
+You can find complete details about the project on our [docs website](https://mephisto.ai).
 
 ## Quickstart
 

docs/README.md

@@ -1,8 +1,8 @@
 # Mephisto Docs
 
-- Looking to get set-up and running quickly with Mephisto? Check out the **[10 minute quickstart](quickstart.md)**.
+- Looking to get set-up and running quickly with Mephisto? Check out the **[10 minute quickstart](https://mephisto.ai/docs/guides/quickstart)**.
 
-- Want to learn more about the different concepts within Mephisto and how they work together? The excellent and thorough **[architecture overview](architecture_overview.md)** should serve as a great deep-dive and reference for beginners and advanced users alike.
+- Want to learn more about the different concepts within Mephisto and how they work together? The excellent and thorough **[architecture overview](https://mephisto.ai/docs/explanations/architecture_overview)** should serve as a great deep-dive and reference for beginners and advanced users alike.
 
 ### Customization