Remove heroku deployment and update docs and tests (#1400)

Author: ml-evs

.github/workflows/ci.yml

@@ -249,22 +249,22 @@ jobs:
         coverage run --append --source optimade optimade/client/cli.py \
            --filter 'nsites = 1' \
            --output-file test_get_async.json \
-           https://optimade.herokuapp.com
+           https://optimade.fly.dev
         test test_get_async.json
 
         coverage run --append --source optimade optimade/client/cli.py \
           --filter 'nsites = 1' \
           --count \
           --output-file test_count.json \
-          https://optimade.herokuapp.com
+          https://optimade.fly.dev
         test test_count.json
 
         coverage run --append --source optimade optimade/client/cli.py \
           --no-async \
           --filter 'nsites = 1' \
           --count \
           --output-file test_count_no_async.json \
-          https://optimade.herokuapp.com
+          https://optimade.fly.dev
         test test_count_no_async.json
 
         diff test_count_no_async.json test_count.json

.github/workflows/ci_cd_updated_master.yml

@@ -135,24 +135,6 @@ jobs:
         sleep: 15
         force: ${{ env.FORCE_PUSH }}
 
-  deploy-heroku:
-    runs-on: ubuntu-latest
-    if: github.repository_owner == 'Materials-Consortia'
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    - name: Deploy to Heroku
-      uses: akhileshns/heroku-deploy@v3.12.12
-      with:
-          heroku_api_key: ${{secrets.HEROKU_API_KEY}}
-          heroku_app_name: "optimade"
-          heroku_email: ${{secrets.HEROKU_EMAIL}}
-          branch: ${{env.DEFAULT_REPO_BRANCH}}
-      env:
-          HD_OPTIMADE_CONFIG_FILE: /app/tests/test_config.json
-          HD_OPTIMADE_BASE_URL: https://optimade.herokuapp.com
-
   deploy-fly:
     env:
         FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

README.md

@@ -31,7 +31,6 @@ OPTIMADE Python tools
   <td align="center">
     <a href="https://github.com/Materials-Consortia/optimade-python-tools/actions?query=branch%3Amaster+"><img alt="Build Status" src="https://img.shields.io/github/workflow/status/Materials-Consortia/optimade-python-tools/CI%20tests?logo=github"></a><br>
     <a href="https://codecov.io/gh/Materials-Consortia/optimade-python-tools"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/Materials-Consortia/optimade-python-tools?logo=codecov&logoColor=white&token=UJAtmqkZZO"></a><br>
-    <a href="https://optimade.herokuapp.com"><img alt="Heroku App Status"  src="https://heroku-shields.herokuapp.com/optimade??logo=heroku"></a>
   </td>
   <td align="center">
     <a href="https://github.com/Materials-Consortia/optimade-python-tools/pulse"><img alt="Commit Activity" src="https://img.shields.io/github/commit-activity/m/Materials-Consortia/optimade-python-tools?logo=github"></a><br>
@@ -50,7 +49,7 @@ This is to enable interoperability among databases that serve crystal structures
 This repository contains a library of tools for implementing and consuming [OPTIMADE APIs](https://www.optimade.org) using Python:
 
 1. [pydantic](https://github.com/pydantic/pydantic) data models for all [OPTIMADE entry types](https://www.optimade.org/optimade-python-tools/latest/all_models/) and endpoint responses, and a [Lark](https://github.com/lark-parser/lark) [EBNF grammar](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) implementation for the OPTIMADE filter language.
-1. A configurable reference server implementation that can make use of either MongoDB or Elasticsearch database backends out-of-the-box, and is readily extensible to other backends. Try it out on the [demo site](https://optimade.herokuapp.com)! The OpenAPI schemas of the server are used to construct the [OPTIMADE schemas](https://schemas.optimade.org/) site.
+1. A configurable reference server implementation that can make use of either MongoDB or Elasticsearch database backends out-of-the-box, and is readily extensible to other backends. Try it out on the [demo site](https://optimade.fly.dev)! The OpenAPI schemas of the server are used to construct the [OPTIMADE schemas](https://schemas.optimade.org/) site.
 1. An [OPTIMADE client](https://www.optimade.org/optimade-python-tools/latest/getting_started/client/) (`optimade-get`) that can query multiple [OPTIMADE providers](https://optimade.org/providers-dashboard) concurrently with a given filter, at the command-line or from Python code.
 1. A fuzzy API validator tool, which may be called from the shell (`optimade-validator`) or used as a GitHub Action from [optimade-validator-action](https://github.com/Materials-Consortia/optimade-validator-action); this validator is used to construct the [providers dashboard](https://optimade.org/providers-dashboard).
 

docs/concepts/validation.md

@@ -12,8 +12,8 @@ To run the script, simply provide an OPTIMADE URL to the script at the command-l
 You can use the following to validate the Heroku deployment of our reference server:
 
 ```shell
-$ optimade-validator https://optimade.herokuapp.com/
-Testing entire implementation at https://optimade.herokuapp.com
+$ optimade-validator https://optimade.fly.dev/
+Testing entire implementation at https://optimade.fly.dev
 ...
 ```
 

docs/getting_started/client.md

@@ -60,14 +60,14 @@ We can refine the search by manually specifying some URLs:
 
 === "Command line"
     ```shell
-    optimade-get --output-file results.json https://optimade.herokuapp.com https://optimade.odbx.science
+    optimade-get --output-file results.json https://optimade.fly.dev https://optimade.odbx.science
     ```
 
 === "Python"
     ```python
     from optimade.client import OptimadeClient
     client = OptimadeClient(
-        base_urls=["https://optimade.herokuapp.com", "https://optimade.odbx.science"]
+        base_urls=["https://optimade.fly.dev", "https://optimade.odbx.science"]
     )
     client.get()
     ```
@@ -97,22 +97,22 @@ At the command-line, the results of the query will be printed to `stdout`, ready
 For example:
 
 ```shell
-optimade-get --filter 'nsites = 1' --output-file results.json https://optimade.herokuapp.com
+optimade-get --filter 'nsites = 1' --output-file results.json https://optimade.fly.dev
 cat results.json
 ```
 
 has the following (truncated) output:
 
 ```json
-{  
+{
   // The endpoint that was queried
-  "structures": {  
+  "structures": {
     // The filter applied to that endpointk
-    "nsites = 1": {  
+    "nsites = 1": {
       // The base URL of the OPTIMADE API
-      "https://optimade.herokuapp.com": {  
+      "https://optimade.fly.dev": {
         // The OPTIMADE API response as if called with an infinite `page_limit`
-        "data": [  
+        "data": [
           {
             "id": "mpf_1",
             "type": "structures",
@@ -147,7 +147,7 @@ This is the same format as the cached results of the Python client:
 
 ```python
 from optimade.client import OptimadeClient
-client = OptimadeClient(base_urls="https://optimade.herokuapp.com")
+client = OptimadeClient(base_urls="https://optimade.fly.dev")
 client.get('nsites = 1')
 client.get('nsites = 2')
 print(client.all_results)
@@ -158,10 +158,10 @@ will return a dictionary with top-level keys:
 {
     "structures": {
         "nsites = 1": {
-            "https://optimade.herokuapp.com": {...}
+            "https://optimade.fly.dev": {...}
         },
         "nsites = 2": {
-            "https://optimade.herokuapp.com": {...}
+            "https://optimade.fly.dev": {...}
         }
     }
 }

tests/server/test_client.py

@@ -14,7 +14,7 @@
 TEST_URLS = [
     "https://example.com",
     "https://example.org",
-    "https://optimade.herokuapp.com",
+    "https://optimade.fly.dev",
 ]
 TEST_URL = TEST_URLS[0]