search

bloomberg / memray

Memray is a memory profiler for Python
https://bloomberg.github.io/memray/
Apache License 2.0
13.17k stars 392 forks source link

Codespaces for Tutorials #601

Closed jcarnaxide closed 4 months ago

jcarnaxide commented 4 months ago

Describe your changes I am adding the ability to spawn a preconfigured codespace for this repo specifically designed for executing the tutorials. This will allow for tutorial ease of use, and required less initial setup by users to run the exercises.

Testing performed I built the documentation with the modifications and they changes all rendered fine. I also spawned the corresponding codespace and the exercises all work as expected.

Additional context One thing to note, is I am not exactly sure how the link provided via the rendered button will work, only because I am pointing to the main branch for the bloomberg/memray repo, which currently does NOT have a devcontainer.json configured. But once, we do, that button should take the user to a screen to configure a corresponding codespace.

Docs for Codespaces You can get an idea what that screen would look like by clicking the following link, pointing to my local branch. https://codespaces.new/jcarnaxide/memray/tree/codespaces-for-tutorials

jcarnaxide commented 4 months ago

@godlygeek I have some additional instructions on how to run the tutorial using github codespaces. If you have time to take a look, and want to include these updates for your sprinting tomorrow, feel free to have a look.

We would also greatly appreciate having this setup for our run through in Pycon Italia this week as well!

@statkute F.Y.I.

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.84%. Comparing base (41248ed) to head (3f9166f). Report is 52 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #601 +/- ## ========================================== + Coverage 92.55% 92.84% +0.29% ========================================== Files 91 92 +1 Lines 11304 11234 -70 Branches 1581 2055 +474 ========================================== - Hits 10462 10430 -32 + Misses 837 804 -33 + Partials 5 0 -5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/601/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/bloomberg/memray/pull/601/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.84% <ø> (+6.90%)` | :arrow_up: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/601/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.84% <ø> (-2.88%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.