{"id":23414215,"url":"https://github.com/unmade/hangman","last_synced_at":"2026-04-28T01:31:27.991Z","repository":{"id":53512822,"uuid":"239015111","full_name":"unmade/hangman","owner":"unmade","description":"Simple REST version of hangman","archived":false,"fork":false,"pushed_at":"2021-03-26T17:39:02.000Z","size":55,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-26T09:15:10.656Z","etag":null,"topics":["fastapi","python3","sqlalchemy"],"latest_commit_sha":null,"homepage":"http://apihangman.herokuapp.com/docs","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unmade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-07T20:17:40.000Z","updated_at":"2021-03-26T17:38:32.000Z","dependencies_parsed_at":"2022-09-12T01:40:14.030Z","dependency_job_id":null,"html_url":"https://github.com/unmade/hangman","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/unmade/hangman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unmade%2Fhangman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unmade%2Fhangman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unmade%2Fhangman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unmade%2Fhangman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unmade","download_url":"https://codeload.github.com/unmade/hangman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unmade%2Fhangman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32362780,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"ssl_error","status_checked_at":"2026-04-27T20:07:00.910Z","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":["fastapi","python3","sqlalchemy"],"created_at":"2024-12-22T19:57:30.339Z","updated_at":"2026-04-28T01:31:27.965Z","avatar_url":"https://github.com/unmade.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hangman\n\nThis is simple REST API to play Hangman game\n\n[![build](https://github.com/unmade/hangman/workflows/Lint%20and%20Test/badge.svg)](https://github.com/unmade/hangman/blob/master/.github/workflows/lint-and-test.yml)\n[![build](https://github.com/unmade/hangman/workflows/Deploy/badge.svg)](https://github.com/unmade/hangman/blob/master/.github/workflows/deploy.yml)\n[![codecov](https://codecov.io/gh/unmade/hangman/branch/master/graph/badge.svg)](https://codecov.io/gh/unmade/hangman)\n\n## Configuration\n\nApp can be configured with environment variables\n\n### App\n\n|Name     | Required | Default | Description|\n|:--------|:-------- |:------- |:-----------|\n|APP_NAME    | - | Hangman | Specifies app name |\n|APP_VERSION | - | -       | Specifies app version. This env is set during build |\n|APP_DEBUG   | - | False   | Whether to run app in debug mode |\n\n### Databases\n\n|Name     | Required | Default | Description|\n|:--------|:-------- |:------- |:-----------|\n|DATABASES_DSN | + | - | Database DSN. Examples: `sqlite:///./test.db`, `postgresql://user:password@host:port/name` |\n\n### Game\n\n|Name     | Required | Default | Description|\n|:--------|:-------- |:------- |:-----------|\n|HANGMAN_WORDS | - | \"3dhubs,marvin,print,filament,order,layer\" | String of comma-separated words to use in the game |\n|HANGMAN_LIVES | - | 5 | Specifies how much times user can ask letters that don't exist |\n\n### Sentry\n\n|Name     | Required | Default | Description|\n|:--------|:-------- |:------- |:-----------|\n|SENTRY_DSN | - | - | Sentry DSN |\n\n## Documentation\n\nCheck out interactive documentation [here](https://apihangman.herokuapp.com/docs)\n\n## Development\n\n### Running locally\n\nCreate a new virtual environment:\n\n```bash\npython3 -m venv .venv\nsource ./.venv/bin/activate\n```\n\nInstall requirements:\n\n```bash\npip install -r requirements/base.txt -r requirements/test.txt\n```\n\nInstall pre-commit hooks:\n\n```bash\npre-commit install\n```\n\nSet python path and the path to db:\n\n```bash\nexport PYTHONPATH=\"$(pwd)\"\nexport DATABASE_DSN=sqlite:///./test.db\n```\n\nApply migrations:\n\n```bash\nalembic upgrade head\n```\n\nRun the app:\n\n```bash\nuvicorn app.main:app --reload\n```\n\n### Testing\n\nTo run test just type:\n\n```bash\nDATABASE_DSN=sqlite:// pytest --cov\n```\n\n### Running in Docker\n\nRunning app docker is pretty straightforward:\n\n```bash\ndocker build . -t \"${IMAGE_NAME}\"\ndocker run --rm --env DATABASE_DSN=\"${DATABASE_DSN}\" -p 8000:80 \"${IMAGE_NAME}\"\n```\n\n### Adding new requirements\n\nThis project relies on [pip-tools](https://github.com/jazzband/pip-tools) to manage requirements.\nTo add a new one update one of the *.in files in [requirements](requirements) directory,\nand then run:\n\n```bash\npip-compile requirements/{updated_file}.in\n```\n\nTo sync with your env:\n\n```bash\npip-sync requirements/base.txt requirements/test.txt requirements/prod.txt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funmade%2Fhangman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funmade%2Fhangman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funmade%2Fhangman/lists"}