https://github.com/nulladmin1/frankenzork-i
First part to a Frankenstein-inspired zork-like video game
https://github.com/nulladmin1/frankenzork-i
Last synced: 6 months ago
JSON representation
First part to a Frankenstein-inspired zork-like video game
- Host: GitHub
- URL: https://github.com/nulladmin1/frankenzork-i
- Owner: nulladmin1
- Created: 2024-10-20T22:59:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T02:39:51.000Z (over 1 year ago)
- Last Synced: 2025-04-07T20:52:19.589Z (12 months ago)
- Language: Python
- Size: 208 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nix Flake Template for Python using Poetry
*All this information is also included in the [README.md](../README.md)*
Initialize using
```shell
nix flake init --template "github:nulladmin1/nix-flake-templates#python-poetry"
```
This is how the structure of the template looks like:
```
📦 python-poetry
├─ 📁 app
│ ├─ 🐍 __init__.py
│ └─ 🐍 main.py
├─ 🔒 flake.lock
├─ ⚙️ flake.nix
├─ 🔒 poetry.lock
├─ ⚙️ pyproject.toml
├─ 📃 README.md
└─ 📁 tests
└─ 🐍 test_main.py
```
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```.
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)
### Run using ```poetry2nix``` (Recommended)
Run app
```shell
nix run
```
### Run using ```Poetry```
Drop into a development shell
```shell
nix develop
```
Install project and its dependencies
```shell
poetry install
```
Run app
```shell
poetry run app
```
### Test using ```Pytest```
Drop into a development shell
```shell
nix develop
```
Install project and its dependencies
```shell
poetry install
```
Run Pytest
```shell
poetry run pytest
```
### (Optional) Format ```flake.nix``` using ```Alejandra```
```shelll
nix fmt
```
### To customize it to your own needs:
* In ```flake.nix```
* Edit description
```nix
{
description = "Nix Flake Template for Python using Poetry";
...
}
```
* Change name of the Poetry Application (In this example, it's called app)
```nix
{
...
app = mkPoetryApplication {projectDir = ./.;};
...
}
```
* Change the name of the Poetry Application and the location of its binary (In this example, both are called app)
```nix
{
...
program = "${app}/bin/app";
...
}
```
* In ```pyproject.toml```
* Change name, version, description, and authors of the project
```toml
[tool.poetry]
name = "app"
version = "0.1.0"
description = ""
authors = ["Your Name "]
```
* Remove and add needed dependencies using ```poetry add ...```
```toml
[tool.poetry.dependencies]
python = "^3.12"
[tool.poetry.group.dev.dependencies]
pytest = "^8.3.3"
```
* Change the name of the scripts and path
```toml
[tool.poetry.scripts]
app = "app.main:main"
```
* For the structure and code
* Rename the ```app/``` directory to the name of your project. Make sure its the same as the path in the ```pyproject.toml```
```shell
📦 python-poetry
├─ 📁 app
│ ├─ 🐍 __init__.py
│ └─ 🐍 main.py
```
* Add necessary code for the program in the previous subdirectory.
* 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
```python
from app.main import main, get_sha256
```
* Add necessary test cases and modifications in the ```tests/``` subdirectory. Prepend all added files in that subdirectory with ```test_```
* 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
```python
from app.main import main, get_sha256
```
* Execution
* If running the project using ```Poetry```, run using:
```shell
poetry run ${PROJECT_NAME}
```
where ${PROJECT_NAME} is the name of the project. Make sure it matches the name of the script in the ```pyproject.toml```
```toml
[tool.poetry.scripts]
${PROJECT_NAME} = "${PROJECT_DIR}.main:main"
```
where ${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/```