A Rya bootstrapped example application framework.

Clone this repository, cd into the project directory, then run uv --sync.

$ git clone https://github.com/uhd-urz/myfw.git ~/myfw
$ cd ~/myfw
$ uv --sync
$ source .venv/bin/activate

Done! myfw should be installed as an executable within the virtual environment. Run myfw and the --help message should be displayed.

1. Open src/myfw/names/names.py, and update the following Enum class:

class AppIdentity(StrEnum):
    app_name = "<new framework name here>"
    app_fancy_name = "<new fancy name here>"
    pypi_name = "<the [project] 'name' from pyproject.toml>"
    log_file_name = f"{app_name}.log"
    config_file_extension = "toml"
    user_config_file_name = f"config.{config_file_extension}"
    project_config_file_name = f"{app_name}.{config_file_extension}"

2. Rename the project directory.

mv src/myfw src/<new framework name from AppIdentity>

3. Update the executable name in pyproject.toml

[project.scripts]
myfw = "<new framework name from AppIdentity>.cli.__main__:app"

4. Run uv --sync to update the virtual environment metadata. Run <new framework name here> on the terminal and the --help message should be displayed like before.