Move packages within src and fix extra things

[dalonsoa]

Description

Moves swmmanywhere and netcomp to a src folder. And then updates pyproject.toml and a variety of other paths here and there to work with this new layout.

Tests pass, documentation builds and the generated wheel contains the right things (both swmmanywhere and netcomp can be imported after installing the wheel on a fresh environment), but I have not check trying to run a full script so I guess there might be some hidden things that need fixing.

Fixes #290 again

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. python -m pytest)
• The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[barneydobson]

@dalonsoa I don't understand these ruff errors - if I correct them to what is in the failed workflow action - it moves them back when I run pre-commit on my machine...

[cheginit]

For coverage you need:

[tool.coverage.report]
exclude_lines = [
  "if TYPE_CHECKING:",
]
omit = [
  "**/__init__.py",
]
ignore_errors = true

[tool.coverage.paths]
source = [ "src", "*/site-packages" ]
omit = [
  "**/__init__.py",
]

[tool.coverage.run]
branch = true
source = [
  "swmmanywhere",
]
omit = [
  "**/__init__.py",
]

Also, instead of:

only-include = ["src"]
sources = ["src"]

you can just do:

packages = [ "src" ]

[dalonsoa]

@dalonsoa I don't understand these ruff errors - if I correct them to what is in the failed workflow action - it moves them back when I run pre-commit on my machine...

Not sure. I've just re-run pre-commit locally and all works now.

[barneydobson]

I followed advice in : astral-sh/ruff#5667 - not sure if that's what did it but the pre-commit seemed to correct itself now..

not sure this is satisfying as pre-commit will now fail locally...

[dalonsoa]

For coverage you need:

[tool.coverage.report]
exclude_lines = [
  "if TYPE_CHECKING:",
]
omit = [
  "**/__init__.py",
]
ignore_errors = true

[tool.coverage.paths]
source = [ "src", "*/site-packages" ]
omit = [
  "**/__init__.py",
]

[tool.coverage.run]
branch = true
source = [
  "swmmanywhere",
]
omit = [
  "**/__init__.py",
]

Could you elaborate why we need all of these?

[dalonsoa]

I followed advice in : astral-sh/ruff#5667 - not sure if that's what did it but the pre-commit seemed to correct itself now

I enabled precommit.ci, which heals some errors automatically, creating new commits with the fixes. See #296

[barneydobson]

I followed advice in : astral-sh/ruff#5667 - not sure if that's what did it but the pre-commit seemed to correct itself now

I enabled precommit.ci, which heals some errors automatically, creating new commits with the fixes. See #296

Not sure that fixes this though - since it is failing locally but passing after pre commit heal?

[dalonsoa]

Runs locally for me locally on the latest version of this branch with no problems.

[dalonsoa]

Everything nice and green :)

[cheginit]

Could you elaborate why we need all of these?

Coverage doesn't work nice with src-layout by default, so some of these options are required to make it correctly detect the lines and report. Also, I usually omit the init to clean up the report.

[dalonsoa]

Done!

[barneydobson]

I dunno - pre-commit run --all-files is still doing ruff corrections on this branch on my machine - I will try on a different machine, maybe I have some weirdness going on on here

[cheginit]

OK, there's an important missing block:

license-files = { paths = ["LICENSE", "src/netcomp/LICENSE.txt"] }

[barneydobson]

this should be down with the swmmanywhere imports no? ruff is moving this in pre-commit on my machine back down to swmmanywhere but precommit.ci is moving it back on here... @cheginit do you have any ideas here as @dalonsoa is unavailable at the mo

[barneydobson]

this should be for the import netcomp line

[cheginit]

Is this about isort? If so, you need to specify what are the first-party packages.

lint.isort.known-first-party = [
  "swmmanywhere",
  "netcomp",
]

[cheginit]

It shouldn't include src, just the name of the package. The pre-commit error sounds like an issue with the service.

[barneydobson]

OK - shall I just abandon precommit.ci and return it to what we had previously for now?

[barneydobson]

oh lol it has passed now - maybe was a one off

[cheginit]

Yeah, it sometimes happens, so don't sweat it 😄