Skip to content

Project restructuring proposal #239

Description

@mafredri

Hi, thanks to everyone who has contributed to this project, it's fantastic!

I recently started making some QoL changes to fix some issues I was having (some PRs I've already opened). While working on the project I did find the project root was getting a bit cluttered so I made a proposal to clean it up:

# Root
.editorconfig
.dockerignore # new
.gitignore # rewritten, relaxed rules
.pre-commit-config.yaml
.yamllint
.github/
  workflows/
    docker-publish.yml
    test.yml
.vscode/
  settings.json
CHANGELOG.md
Dockerfile
LICENSE
README.md
compose.yaml
config.example.ini # new, from readme
pyproject.toml # new, pytest + black/isort config
repository.yaml
requirements.txt
run.sh

# Runtime config (gitignored contents)
config/
  .gitkeep
  iddf/ # hc-login.py zip output

# Application source (moved from root)
src/
  hc2mqtt.py
  hc-login.py
  HCDevice.py
  HCSocket.py
  HADiscovery.py
  HCxml2json.py
  discovery.yaml

# HA app config (renamed from home-assistant-addon/)
app/
  config.yaml

# Tests
tests/
  __init__.py
  conftest.py
  README.md
  requirements-test.txt
  test_HADiscovery.py
  test_HCDevice.py
  test_hc2mqtt.py

# Research
research/
  find-psk.frida # moved from root

I'd be happy to implement this, if it seems reasonable to you all.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions