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

Change package name back to matrix-sygnal #385

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Change package name back to matrix-sygnal #385

merged 6 commits into from
Jun 26, 2024

Conversation

devonh
Copy link
Contributor

@devonh devonh commented Jun 20, 2024

The package name was accidentally changed in #374
This PR changes it back.

@devonh devonh requested a review from a team as a code owner June 20, 2024 15:45
@devonh
Copy link
Contributor Author

devonh commented Jun 21, 2024

Since we are now using poetry, poetry requires the top level package folder to match the package name.
So in order to rename the package to matrix-sygnal, I had to move the sygnal directory to matrix_sygnal. This results in a change to how sygnal is run.

With this change, you need to run sygnal using:
python -m matrix_sygnal.sygnal

This could be even more of a footgun than having a new package name. (Having a new package name of sygnal means existing installs could end up with multiple copies of Sygnal in a virtualenv since the old package name was matrix-sygnal and doesn't conflict with the current name)

@devonh
Copy link
Contributor Author

devonh commented Jun 21, 2024

Since we are now using poetry, poetry requires the top level package folder to match the package name. So in order to rename the package to matrix-sygnal, I had to move the sygnal directory to matrix_sygnal. This results in a change to how sygnal is run.

With this change, you need to run sygnal using: python -m matrix_sygnal.sygnal

This could be even more of a footgun than having a new package name. (Having a new package name of sygnal means existing installs could end up with multiple copies of Sygnal in a virtualenv since the old package name was matrix-sygnal and doesn't conflict with the current name)

This has been resolved & is no longer true.
You can now continue to run using python -m sygnal.sygnal

erikjohnston
erikjohnston previously approved these changes Jun 24, 2024
@devonh devonh merged commit a6caf25 into main Jun 26, 2024
5 checks passed
@devonh devonh deleted the devon/package-name branch June 26, 2024 15:54
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