{"id":25207057,"url":"https://github.com/santteegt/puzzle-solver","last_synced_at":"2025-04-05T03:24:18.855Z","repository":{"id":40617877,"uuid":"507766182","full_name":"santteegt/puzzle-solver","owner":"santteegt","description":null,"archived":false,"fork":false,"pushed_at":"2022-06-27T06:59:30.000Z","size":179,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T11:35:42.464Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/santteegt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-27T04:49:54.000Z","updated_at":"2022-06-27T04:50:47.000Z","dependencies_parsed_at":"2022-08-27T01:01:59.186Z","dependency_job_id":null,"html_url":"https://github.com/santteegt/puzzle-solver","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santteegt%2Fpuzzle-solver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santteegt%2Fpuzzle-solver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santteegt%2Fpuzzle-solver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/santteegt%2Fpuzzle-solver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/santteegt","download_url":"https://codeload.github.com/santteegt/puzzle-solver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247282498,"owners_count":20913381,"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","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-02-10T11:30:36.794Z","updated_at":"2025-04-05T03:24:18.835Z","avatar_url":"https://github.com/santteegt.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Puzzle Solver\n\nThis is just another Puzzle Solver written in Python. It shows how to use `requests` to solve a puzzle using an external API. `Pytest` was used for writing mocks and unit tests.\n\n![Output Console](sample_output.png \"Output Console\")\n\n### Requirements\n\n* Git (Pre-installed)\n* Python 3.x (Pre-installed)\n* Pip (Pre-installed)\n* Virtualenv\n\n```\npip install virtualenv\n```\n\n### Clone repository\n\n```\ngit clone https://github.com/santteegt/puzzle-solver.git\n```\n\nThe rest of this guide assumes the repository was cloned in `HOME=/project/local/directory` and you have a terminal poiting to the project's root folder \n\n### SetUp Local Environment\n\n```\ncd $HOME\nvirtualenv .venv -p 3.8\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\n### Executing the PuzzleSolver\n\nTo execute the PuzzleSolver, you need to provide a valid email address as a parameter\n\n```\npython main.py -e \u003cyour@email.com\u003e\n```\n\n### Running tests\n\n```\npytest tests\n```\n\n### Project Structure\n\n- [tests](./tests/): UnitTest folder\n  * [test_api](./tests/test_api.py): Unit Tests for the `api` module\n  * [test_puzzle](./tests/test_puzzle.py): Unit Tests for the `puzzle` module\n- [api.py](./api.py): Module that communicates with the Puzzle API\n- [main.py](./main.py): Entrypoint for executing the PuzzleSolver\n- [puzzle.py](./puzzle.py): PuzzleSolver module. It cointains the required`check` function\n\n\n### Licence\n\n[MIT](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantteegt%2Fpuzzle-solver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsantteegt%2Fpuzzle-solver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsantteegt%2Fpuzzle-solver/lists"}