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

add ipython extension for rich #1274

Merged

Conversation

nathanrpage97
Copy link
Contributor

@nathanrpage97 nathanrpage97 commented Jun 6, 2021

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

Checklist

  • I've run the latest black with default args on new code.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
  • I've added tests for new code.
  • I accept that @willmcgugan may be pedantic in the code review.

Description

I think that we can provide better integration with IPython by creating an extension. For now I have kept it rather basic, but later on there could be custom magic commands that could be added.

@nathanrpage97
Copy link
Contributor Author

nathanrpage97 commented Jun 6, 2021

If you do not want it in the __init__.py then we could rename _extension.py to ipython.py and have the user call it via %load_ext rich.ipython. This is a common convention I see being used by the IPython community.

@codecov
Copy link

codecov bot commented Jun 6, 2021

Codecov Report

Merging #1274 (9a65f49) into master (d5d08a2) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1274   +/-   ##
=======================================
  Coverage   99.73%   99.73%           
=======================================
  Files          69       70    +1     
  Lines        6459     6461    +2     
=======================================
+ Hits         6442     6444    +2     
  Misses         17       17           
Flag Coverage Δ
unittests 99.73% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
rich/__init__.py 100.00% <100.00%> (ø)
rich/_extension.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7592f09...9a65f49. Read the comment docs.

@willmcgugan
Copy link
Collaborator

Thanks!

@willmcgugan willmcgugan merged commit 2002463 into Textualize:master Jun 9, 2021
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.

None yet

2 participants