{"id":30240391,"url":"https://github.com/hypothesis/report","last_synced_at":"2025-08-15T04:38:23.381Z","repository":{"id":62210753,"uuid":"536973776","full_name":"hypothesis/report","owner":"hypothesis","description":"The internal global reporting product for Hypothesis","archived":false,"fork":false,"pushed_at":"2025-08-04T08:05:56.000Z","size":532,"stargazers_count":1,"open_issues_count":15,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-08-04T11:59:15.142Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypothesis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-15T10:25:45.000Z","updated_at":"2025-08-04T08:02:38.000Z","dependencies_parsed_at":"2023-10-04T01:22:58.479Z","dependency_job_id":"0b48878f-b0a6-4534-a1fe-350c3a7a968e","html_url":"https://github.com/hypothesis/report","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hypothesis/report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Freport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Freport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Freport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Freport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypothesis","download_url":"https://codeload.github.com/hypothesis/report/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Freport/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270524416,"owners_count":24600195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-15T04:38:20.810Z","updated_at":"2025-08-15T04:38:23.372Z","avatar_url":"https://github.com/hypothesis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://github.com/hypothesis/report/actions/workflows/ci.yml?query=branch%3Amain\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/hypothesis/report/ci.yml?branch=main\"\u003e\u003c/a\u003e\n\u003ca\u003e\u003cimg src=\"https://img.shields.io/badge/python-3.11-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hypothesis/report/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-BSD--2--Clause-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/hypothesis/cookiecutters/tree/main/pyapp\"\u003e\u003cimg src=\"https://img.shields.io/badge/cookiecutter-pyapp-success\"\u003e\u003c/a\u003e\n\u003ca href=\"https://black.readthedocs.io/en/stable/\"\u003e\u003cimg src=\"https://img.shields.io/badge/code%20style-black-000000\"\u003e\u003c/a\u003e\n\n# Report\n\nThe internal global reporting product for Hypothesis.\n\nUsed for internal purposes only.\n\n## Environment variables\n\n| Name                    | Example                                | Notes                                                  |\n|-------------------------|----------------------------------------|--------------------------------------------------------|\n| `DATABASE_URL`          | `postgresql://user:pw@host/report`     | Postgres DSN for the report DB                         |\n| `HUBSPOT_API_KEY`       | `01234567-89ab-cdef-0123-456789abcdef` | API key for integration with Hubspot                   |\n| `H_CA_DATABASE_URL`     | `postgresql://user:pw@host/h`          | Connection to H (Canada)                               |\n| `H_US_DATABASE_URL`     | `postgresql://user:pw@host/h`          | Connection to H (US)                                   |\n| `LMS_CA_DATABASE_URL`   | `postgresql://user:pw@host/lms`        | Connection to LMS (Canada)                             |\n| `LMS_US_DATABASE_URL`   | `postgresql://user:pw@host/lms`        | Connection to LMS (US)                                 |\n| `MB_DB_USER`            | `metabase`                             | The username Metabase will use to access the report DB |\n| `NEW_RELIC_APP_NAME`    | `report`                               | Report's New Relic name                                |\n| `NEW_RELIC_ENVIRONMENT` | `prod`                                 | The environment we are deployed in                     |\n| `NEW_RELIC_LICENSE_KEY` | `01234567-89ab-cdef-0123-456789abcdef` | The licence key from New Relic                         |\n| `SENTRY_DSN`            | `01234567-89ab-cdef-0123-456789abcdef` | Connection details for Sentry error reporting          |\n| `SENTRY_ENVIRONMENT`    | `prod`                                 | The Sentry environment                                 |\n\nOn top of the service own environment variables these are the metabase variables that we use:\n\n| Name           | Example     | Notes                                      |\n|----------------|-------------|--------------------------------------------|\n| `MB_DB_DBNAME` | `metabase`  | Metabase database name                     |\n| `MB_DB_HOST`   | `localhost` | Metabase database host                     |\n| `MB_DB_PASS`   | `pass`      | Metabase database password                 |\n| `MB_DB_PORT`   | `5432`      | Metabase database port                     |\n| `MB_DB_TYPE`   | `postgres`  | Metabase database type. We use `postgres`. |\n| `MB_DB_USER`   | `user`      | Metabase database user                     |\n\nIn addition, we are also providing some custom Java options\n\n| Name        | Value                                                     | Description         |\n|-------------|-----------------------------------------------------------|---------------------|\n| `JAVA_OPTS` | `-Dlog4j.configurationFile=file://conf/report-log4j2.xml` | Custom log4j config |\n\nThe full list of supported variables by metabase can be found here:\n\nhttps://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html\n\n## Setting up Your Report Development Environment\n\nFirst you'll need to install:\n\n* [Git](https://git-scm.com/).\n  On Ubuntu: `sudo apt install git`, on macOS: `brew install git`.\n* [GNU Make](https://www.gnu.org/software/make/).\n  This is probably already installed, run `make --version` to check.\n* [pyenv](https://github.com/pyenv/pyenv).\n  Follow the instructions in pyenv's README to install it.\n  The **Homebrew** method works best on macOS.\n  The **Basic GitHub Checkout** method works best on Ubuntu.\n  You _don't_ need to set up pyenv's shell integration (\"shims\"), you can\n  [use pyenv without shims](https://github.com/pyenv/pyenv#using-pyenv-without-shims).\n* [Docker Desktop](https://www.docker.com/products/docker-desktop/).\n  On Ubuntu follow [Install on Ubuntu](https://docs.docker.com/desktop/install/ubuntu/).\n  On macOS follow [Install on Mac](https://docs.docker.com/desktop/install/mac-install/).\n\nThen to set up your development environment:\n\n```terminal\ngit clone https://github.com/hypothesis/report.git\ncd report\nmake services\nmake devdata\nmake help\n```\n\n## Changing the Project's Python Version\n\nTo change what version of Python the project uses:\n\n1. Change the Python version in the\n   [cookiecutter.json](.cookiecutter/cookiecutter.json) file. For example:\n\n   ```json\n   \"python_version\": \"3.10.4\",\n   ```\n\n2. Re-run the cookiecutter template:\n\n   ```terminal\n   make template\n   ```\n\n3. Re-compile the `requirements/*.txt` files.\n   This is necessary because the same `requirements/*.in` file can compile to\n   different `requirements/*.txt` files in different versions of Python:\n\n   ```terminal\n   make requirements\n   ```\n\n4. Commit everything to git and send a pull request\n\n## Changing the Project's Python Dependencies\n\n### To Add a New Dependency\n\nAdd the package to the appropriate [`requirements/*.in`](requirements/)\nfile(s) and then run:\n\n```terminal\nmake requirements\n```\n\n### To Remove a Dependency\n\nRemove the package from the appropriate [`requirements/*.in`](requirements)\nfile(s) and then run:\n\n```terminal\nmake requirements\n```\n\n### To Upgrade or Downgrade a Dependency\n\nWe rely on [Dependabot](https://github.com/dependabot) to keep all our\ndependencies up to date by sending automated pull requests to all our repos.\nBut if you need to upgrade or downgrade a package manually you can do that\nlocally.\n\nTo upgrade a package to the latest version in all `requirements/*.txt` files:\n\n```terminal\nmake requirements --always-make args='--upgrade-package \u003cFOO\u003e'\n```\n\nTo upgrade or downgrade a package to a specific version:\n\n```terminal\nmake requirements --always-make args='--upgrade-package \u003cFOO\u003e==\u003cX.Y.Z\u003e'\n```\n\nTo upgrade **all** packages to their latest versions:\n\n```terminal\nmake requirements --always-make args=--upgrade\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Freport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypothesis%2Freport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Freport/lists"}