{"id":23359645,"url":"https://github.com/nulladmin1/frankenzork-i","last_synced_at":"2025-10-14T19:10:53.122Z","repository":{"id":258869019,"uuid":"875823431","full_name":"nulladmin1/Frankenzork-I","owner":"nulladmin1","description":"First part to a Frankenstein-inspired zork-like video game","archived":false,"fork":false,"pushed_at":"2024-10-23T02:39:51.000Z","size":213,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T20:52:19.589Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nulladmin1.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-20T22:59:29.000Z","updated_at":"2024-10-23T02:39:54.000Z","dependencies_parsed_at":"2024-12-27T18:45:12.616Z","dependency_job_id":"883ced81-1dd0-4487-b918-ee5f8a3cc297","html_url":"https://github.com/nulladmin1/Frankenzork-I","commit_stats":null,"previous_names":["nulladmin1/frankenzork-i"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nulladmin1/Frankenzork-I","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nulladmin1%2FFrankenzork-I","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nulladmin1%2FFrankenzork-I/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nulladmin1%2FFrankenzork-I/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nulladmin1%2FFrankenzork-I/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nulladmin1","download_url":"https://codeload.github.com/nulladmin1/Frankenzork-I/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nulladmin1%2FFrankenzork-I/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279020647,"owners_count":26086895,"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-10-14T02:00:06.444Z","response_time":60,"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":"2024-12-21T11:11:28.733Z","updated_at":"2025-10-14T19:10:53.094Z","avatar_url":"https://github.com/nulladmin1.png","language":"Python","readme":"# Nix Flake Template for Python using Poetry\n\n*All this information is also included in the [README.md](../README.md)*\n\n\nInitialize using\n```shell  \nnix flake init --template \"github:nulladmin1/nix-flake-templates#python-poetry\"\n```\n\nThis is how the structure of the template looks like:\n```\n📦 python-poetry\n├─ 📁 app\n│  ├─ 🐍 __init__.py\n│  └─ 🐍 main.py\n├─ 🔒 flake.lock\n├─ ⚙️ flake.nix\n├─ 🔒 poetry.lock\n├─ ⚙️ pyproject.toml\n├─ 📃 README.md\n└─ 📁 tests\n   └─ 🐍 test_main.py\n ```\n \n It includes a basic Poetry project that returns an SHA256 encoded string of the user's input. It has a testcase that can be run using ```Pytest``` or ```unittest```.\n \n The flake is able to run in the specified systems listed in the flake. It contains a ```devShel``` as an output with ```Python``` and ```Poetry```, and an app as an output that builds a ```Poetry``` project using ```poetry2nix```. This section is inspired by the [official docs for ```poetry2nix```](https://github.com/nix-community/poetry2nix)\n\n### Run using ```poetry2nix``` (Recommended)\n\nRun app\n```shell\nnix run\n```\n \n ### Run using ```Poetry```\n \nDrop into a development shell\n ```shell\n nix develop\n ```\n\nInstall project and its dependencies\n```shell\npoetry install\n```\n\nRun app\n```shell\npoetry run app\n```\n\n### Test using ```Pytest```\n\nDrop into a development shell\n```shell\nnix develop\n```\n\nInstall project and its dependencies\n```shell\npoetry install\n```\n\nRun Pytest\n```shell\npoetry run pytest\n```\n\n### (Optional) Format ```flake.nix``` using ```Alejandra```\n```shelll\nnix fmt\n```\n\n\n### To customize it to your own needs:\n\n* In ```flake.nix```\n\t* Edit description\n\t\t```nix\n\t\t{\n\t\t\tdescription = \"Nix Flake Template for Python using Poetry\";\n\t\t...\n\t\t}\t\n\t\t```\n\t* Change name of the Poetry Application (In this example, it's called app)\n\t\t```nix\n\t\t{\n\t\t...\n\t\t\tapp = mkPoetryApplication {projectDir = ./.;};\n\t\t...\n\t\t}\n\t\t```\n\t* Change the name of the Poetry Application and the location of its binary (In this example, both are called app)\n\t\t```nix\n\t\t{\n\t\t...\t\t\n\t\t\t program = \"${app}/bin/app\";\n\t\t...\t\n\t\t}\n\t\t```\n* In ```pyproject.toml```\n\t* Change name, version, description, and authors of the project\n\t\t```toml\n\t\t[tool.poetry]\n\t\tname = \"app\"\n\t\tversion = \"0.1.0\"\n\t\tdescription = \"\"\n\t\tauthors = [\"Your Name \u003cyou@example.com\u003e\"]\n\t\t```\n\t* Remove and add needed dependencies using ```poetry add ...```\n\t\t```toml\t\t\n\t\t[tool.poetry.dependencies]\n\t\tpython = \"^3.12\"\n\t\t\n\t\t\n\t\t[tool.poetry.group.dev.dependencies]\n\t\tpytest = \"^8.3.3\"\n\t\t```\n\t* Change the name of the scripts and path\n\t\t```toml\n\t\t[tool.poetry.scripts]\n\t\tapp = \"app.main:main\"\n\t\t```\n* For the structure and code\n\t* Rename the ```app/``` directory to the name of your project. Make sure its the same as the path in the ```pyproject.toml```\n\t\t```shell\n\t\t📦 python-poetry\n\t\t├─ 📁 app\n\t\t│  ├─ 🐍 __init__.py\n\t\t│  └─ 🐍 main.py\n\t\t```\n\t* Add necessary code for the program in the previous subdirectory. \n\t* Make sure that for the ```__init__.py```, that it imports from the name of your project, and it imports the necessary functions to be used as a library\n\t\t```python\n\t\tfrom app.main import main, get_sha256\n\t\t```\n\t* Add necessary test cases and modifications in the ```tests/``` subdirectory. Prepend all added files in that subdirectory with ```test_```\n\t* Make sure that for the ```test_main.py```, that it imports from the name of your project, and it imports the necessary functions for testing\n\t\t```python\n\t\tfrom app.main import main, get_sha256\n\t\t```\n\t\n* Execution\n\t* If running the project using ```Poetry```, run using:\n\t\t```shell\n\t\tpoetry run ${PROJECT_NAME}\n\t\t```\n\t\twhere ${PROJECT_NAME} is the name of the project. Make sure it matches the name of the script in the ```pyproject.toml```\n\t\t```toml\n\t\t[tool.poetry.scripts]\n\t\t${PROJECT_NAME} = \"${PROJECT_DIR}.main:main\"\n\t\t```\n\t\twhere ${PROJECT_NAME} is the name of the project, and the ${PROJECT_DIR} is the location of the project (recommended to be the same as the PROJECT_NAME). By default it's: ```app/```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulladmin1%2Ffrankenzork-i","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnulladmin1%2Ffrankenzork-i","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnulladmin1%2Ffrankenzork-i/lists"}