{"id":20740661,"url":"https://github.com/tern-tools/tern-rest-api","last_synced_at":"2026-04-21T12:02:05.605Z","repository":{"id":43291085,"uuid":"460142753","full_name":"tern-tools/tern-rest-api","owner":"tern-tools","description":"Code for Tern's REST API","archived":false,"fork":false,"pushed_at":"2022-06-03T11:04:31.000Z","size":3260,"stargazers_count":0,"open_issues_count":10,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-11T11:56:50.390Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/tern-tools.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}},"created_at":"2022-02-16T19:10:49.000Z","updated_at":"2022-02-24T21:25:18.000Z","dependencies_parsed_at":"2022-07-22T05:32:09.671Z","dependency_job_id":null,"html_url":"https://github.com/tern-tools/tern-rest-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tern-tools/tern-rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tern-tools%2Ftern-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tern-tools%2Ftern-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tern-tools%2Ftern-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tern-tools%2Ftern-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tern-tools","download_url":"https://codeload.github.com/tern-tools/tern-rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tern-tools%2Ftern-rest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32091053,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T11:25:29.218Z","status":"ssl_error","status_checked_at":"2026-04-21T11:25:28.499Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-11-17T06:29:31.842Z","updated_at":"2026-04-21T12:02:05.585Z","avatar_url":"https://github.com/tern-tools.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tern REST API\n\n---\n**NOTE**\n\nThis project still not functional. Please wait for the first functional release\n(0.0.1)\n\n---\n\nThe Tern REST API is a RESTful API for Tern Project.\n\nCurrently, the API is not functional as it is still in the Specification development and project structure phase.\n\nThe specification is available at [Tern REST API Offline Swagger](https://tern-tools.github.io/tern-rest-api/), and contributions are welcome.\n\nMainly the API is implemented asynchronously on the server-side as the tern\nreports can take a while to be generated.\n\n```mermaid\n  sequenceDiagram\n    participant User\n    participant API\n    participant Tern\n    User-\u003e\u003eAPI: GET /api/v1/version\n    API--\u003e\u003eUser: 200 OK, JSON with version data\n    User-\u003e\u003eAPI: POST /api/v1/reports with JSON payload\n    API--\u003e\u003eUser: 200 OK, JSON with request id\n    User-\u003e\u003eAPI: POST /api/v1/reports/status with JSON payload\n    API--\u003e\u003eUser: 200 OK, JSON with status RUNNING\n    API-\u003e\u003eTern: Process the request calling asynchronous\n    Tern-\u003e\u003eTern: Processing\n    loop\n    User-\u003e\u003eAPI: POST /api/v1/reports/status with JSON payload\n    Tern-\u003e\u003eTern: Processing\n    API--\u003e\u003eUser: 200 OK, JSON with status RUNNING or UNKOWN\n    end\n    Tern-\u003e\u003eAPI: Provides the answer for the id\n    User-\u003e\u003eAPI: POST /api/v1/reports/status with JSON payload\n    API--\u003e\u003eUser: 200 OK, JSON with status FAILED with error or DONE with report\n```\n\n## Development\n\nThis repository has the ``requirements.txt`` and the ``requirements-dev.txt``\nfiles to help build your virtual environment.\n\nWe also recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to manage your virtual environment.\n\n```shell\n$ Pip install pipenv\n$ pipenv shell\n```\n\nInstall development requirements\n```shell\n$ pipenv install -d\n```\n\n### Running the development Tern REST API\n\n\nRuning the API locally\n\n```shell\n$ flask run --reload\n```\n\nOpen http://localhost:5000/ in your browser.\n\n## Tests\n\nWe use [Tox](https://tox.wiki/en/latest/) to manage running the tests.\n\nRunning tests\n```shell\n$ tox\n```\n\n## Managing the requirements\n\nInstalling new requirements\n\n```shell\n$ pipenv install {package}\n```\n\nDevelopment requirements\n```shell\n$ pipenv install -d {package}\n```\n\nUpdating packages\n```shell\n$ pipenv update\n```\n\nUpdating the ``requirements.txt`` and ``requirements-dev.txt``\n```shell\n$ pipenv lock -r \u003e requirements.txt\n$ pipenv lock -r -d \u003e requirements-dev.txt\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftern-tools%2Ftern-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftern-tools%2Ftern-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftern-tools%2Ftern-rest-api/lists"}