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

README.md: Improve PyPI install instructions #37261

Merged
merged 2 commits into from
Feb 29, 2024

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Feb 8, 2024

Based on https://groups.google.com/g/sage-devel/c/1viBzw-ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI.

We also improve sage_conf so that python3 -m sage_conf is equivalent to sage-config.
After the next stable release is out, we can use this to simplify these installation instructions.

Blocker because we need this to go in the 10.3 stable release.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@tobiasdiez
Copy link
Contributor

Removing blocker as there are problems with other PRs, see #37428 for more details.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 23, 2024

Restoring "blocker" -- this PR needs to go into the stable release.
Same comment as #37351 (comment) -- #37428 has absolutely no details, mass removal of the "blocker" label on 9 PRs is not OK.

@mkoeppe mkoeppe force-pushed the sage_conf_install_instructions branch from 279e8e2 to 41ad0b5 Compare February 25, 2024 17:38
@vbraun
Copy link
Member

vbraun commented Feb 25, 2024

shouldn''t really be a blocker, oh well pet PR strikes again

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 25, 2024

Thanks for the review.

In a typical project, I'd say that fixing installation instructions ahead of a release would be considered normal maintainer activity.

vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 25, 2024
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

Based on https://groups.google.com/g/sage-devel/c/1viBzw-
ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI.

We also improve **sage_conf** so that `python3 -m sage_conf` is
equivalent to `sage-config`.
After the next stable release is out, we can use this to simplify these
installation instructions.

Blocker because we need this to go in the 10.3 stable release.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37261
Reported by: Matthias Köppe
Reviewer(s):
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 26, 2024
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

Based on https://groups.google.com/g/sage-devel/c/1viBzw-
ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI.

We also improve **sage_conf** so that `python3 -m sage_conf` is
equivalent to `sage-config`.
After the next stable release is out, we can use this to simplify these
installation instructions.

Blocker because we need this to go in the 10.3 stable release.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37261
Reported by: Matthias Köppe
Reviewer(s):
Copy link

Documentation preview for this PR (built with commit 41ad0b5; changes) is ready! 🎉

@vbraun vbraun merged commit 9cc87c2 into sagemath:develop Feb 29, 2024
16 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants