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: using poetry for dependency management #13

Merged
merged 1 commit into from
Feb 26, 2024

Conversation

chanind
Copy link
Collaborator

@chanind chanind commented Feb 26, 2024

This PR sets up Poetry for dependency management.

In the process of adding this, this PR does the following:

  • removes pylint from requirements.txt and replaces it with flake8, since all the linting in CI uses flake8.
  • adds isort since it's referenced in the .vscode config, but seemed to be absent from the actual requirements
  • updates the Github Actions config to install via Poetry, and also check black and isort formatting
  • updates the Makefile to use Poetry, and fills in the make format and make check-format commands
  • runs black and isort, which resulted in a lot of reformatting
  • Updates the README to reference Poetry

This PR leaves the following out:

  • Leaves requirements.txt in case users are already relying on this to install dependencies. This can be removed if needed (and probably should be at some point)
  • Does not add the poetry.lock file to this repo. Since this will be eventually published as a library, it's best not to include the lockfile in the repo IMO.
  • Does not move the main sae_training and sae_analysis to a common subfolder. This will need to be done before publishing this as a PyPI module.

@jbloomAus
Copy link
Owner

Thanks, this is really great work!

@jbloomAus jbloomAus merged commit 496f7b4 into jbloomAus:main Feb 26, 2024
2 checks passed
@chanind chanind deleted the poetry branch February 29, 2024 00:28
tom-pollak pushed a commit to tom-pollak/SAELens that referenced this pull request Oct 22, 2024
chore: using poetry for dependency management
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