Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Migrate to pyproject.toml #241

Merged
merged 34 commits into from
Jan 13, 2025
Merged

chore: Migrate to pyproject.toml #241

merged 34 commits into from
Jan 13, 2025

Conversation

tedil
Copy link
Member

@tedil tedil commented Jan 10, 2025

In this PR:

  • the old setuptools setup.py is replaced by a pyproject.toml (e.g. for use with uv).
  • package layout is migrated to the src/ package layout
  • github workflows for linting and testing are updated
  • linting and formatting is now done via ruff (instead of flake + isort + black)
  • readthedocs setup has been adjusted for v2

Copy link
Contributor

github-actions bot commented Jan 10, 2025

Please check your code via make lint.

@tedil
Copy link
Member Author

tedil commented Jan 11, 2025

Right now, 3 2 tests are failing:

  1. test_archive_readme.py::test_run_archive_readme_smoke_test: this is because the symlinks in the test directory don't point anywhere meaningful, i.e. the files simply do not exist within this repository
  2. test_seasnap_itransfer_results.py::test_run_seasnap_itransfer_results_smoke_test: this fails because there's some wonky logic for determining the source files from the input string (cmd_block) and subsequent issues with test file paths. it instantiated its own mock filesystem instead of using the existing fixture
  3. test_snappy_workflows.py::test_could_import_module tests whether snappy_pipeline can be imported, which is not listed as a dependency anywhere.

  1. can probably be fixed by ensuring these files actually exist.
  2. fixed
  3. it should be mentioned somewhere that some commands are only available when there's a snappy_pipeline installation within the same environment?

Copy link
Contributor

@Nicolai-vKuegelgen Nicolai-vKuegelgen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tedil tedil enabled auto-merge (squash) January 13, 2025 12:28
@tedil tedil disabled auto-merge January 13, 2025 12:31
@tedil tedil merged commit bb4cda5 into main Jan 13, 2025
4 checks passed
@tedil tedil deleted the update-project branch January 13, 2025 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants