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

Perform a complete environment refresh for Studio install, build, deploy #255

Merged
merged 12 commits into from
Dec 18, 2024

Conversation

joanise
Copy link
Member

@joanise joanise commented Dec 13, 2024

PR Goal?

Big jump in all the environment management for ReadAlongs/Studio:

  • Replace soon-to-be-deprecated setup.py and requirements*.txt by pyproject.toml
  • Move to the latest Heroku stack (heroku-24)
  • Move production on Heroku to the latest Python (3.13.1)

We still need a requirements.txt file for Heroku, but it's now effectively a lock file generated using hatch.

Feedback sought?

General review

Priority?

medium

Tests added?

yes, CI now has a dedicated reproducing the full Heroku way to build

How to test?

This version is currently deployed in preview mode on the heroku-24 stack at:

https://readalong-studio-heroku-24-488739ed89f8.herokuapp.com/api/v1/docs

(blocked as "Suspicious" on NRC networks, works elsewhere)

Confidence?

pretty high

Version change?

no

Copy link

semanticdiff-com bot commented Dec 13, 2024

Review changes with  SemanticDiff

Changed Files
File Status
  readalongs/web_api.py  4% smaller
  .github/workflows/matrix-tests.yml Unsupported file format
  .github/workflows/tests.yml Unsupported file format
  Contributing.md Unsupported file format
  MANIFEST.in Unsupported file format
  README.md Unsupported file format
  bin/post_compile Unsupported file format
  docs/requirements.txt Unsupported file format
  pyproject.toml Unsupported file format
  readme-heroku.md Unsupported file format
  requirements.api.txt Unsupported file format
  requirements.ci.txt Unsupported file format
  requirements.dev.txt Unsupported file format
  requirements.min.txt Unsupported file format
  requirements.txt Unsupported file format
  runtime.txt Unsupported file format
  setup.cfg Unsupported file format
  setup.py  0% smaller

@joanise joanise requested a review from roedoejet December 13, 2024 22:26
Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.06%. Comparing base (75d7e27) to head (15c8745).
Report is 13 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #255   +/-   ##
=======================================
  Coverage   88.06%   88.06%           
=======================================
  Files          21       21           
  Lines        1810     1810           
  Branches      327      327           
=======================================
  Hits         1594     1594           
  Misses        179      179           
  Partials       37       37           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@roedoejet roedoejet left a comment

Choose a reason for hiding this comment

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

I've got a question about the MANIFEST.in file and whether it's necessary anymore. Also, while looking at the docs in the demo API that is spun up I noticed that the help message for the /langs endpoint is incorrect. It gives this as an example:


[
    {"code": "alq", names: { "alq": "Anishinaabemowin", "_": "Algonquin" }},
    {"code": "atj", names: { "atj": "Nehiromowin", "_": "Atikamekw" }},
    {"code": "fra", names: { "fra": "Français", "_": "French" }},
    ...
]

but Français, Anishinaabemowin, and Nehiromowin don't actually show up, and I can't see any other examples of this. Also - by this logic, why is _ not eng?

@joanise
Copy link
Member Author

joanise commented Dec 16, 2024

the help message for the /langs endpoint

I fixed the langs help message.

_ was meant to be the key for the default display name, which is usually but not always English, and the other keys for names localized in specific languages, but in practice we have not done any of this localization work, so it's scaffolding for a future feature we have not implemented. I've adjusted the help to make that clear.

image

@joanise joanise force-pushed the dev.ej/pyproject.toml branch 2 times, most recently from 4f8811e to 6d5e347 Compare December 16, 2024 22:02
@joanise joanise requested a review from roedoejet December 17, 2024 22:15
@joanise joanise force-pushed the dev.ej/pyproject.toml branch from a7cecdb to 103c232 Compare December 18, 2024 14:56
@joanise joanise force-pushed the dev.ej/pyproject.toml branch from 103c232 to 15c8745 Compare December 18, 2024 20:13
@joanise joanise merged commit e77e478 into main Dec 18, 2024
8 checks passed
@joanise joanise deleted the dev.ej/pyproject.toml branch December 18, 2024 21:03
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.

3 participants