Features/IPython 0.13

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(start ipython feature)
 
(feature done)
 
(8 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
<!-- The actual name of your feature page should look something like: Features/Your_Feature_Name.  This keeps all features in the same namespace -->
 
<!-- The actual name of your feature page should look something like: Features/Your_Feature_Name.  This keeps all features in the same namespace -->
  
= Feature Name <!-- The name of your feature --> =
+
= IPython 0.13 <!-- The name of your feature --> =
  
 
== Summary ==
 
== Summary ==
Line 19: Line 19:
 
== Current status ==
 
== Current status ==
 
* Targeted release: [[Releases/18 | Fedora 18 ]]  
 
* Targeted release: [[Releases/18 | Fedora 18 ]]  
* Last updated: 2012-07-02
+
* Last updated: 2012-10-09
* Percentage of completion: 00%
+
* Percentage of completion: 100%
 
+
  
 
== Detailed Description ==
 
== Detailed Description ==
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 +
Update to the most recent IPython version 0.13 and package split it into subpackages, so one doesn't require to install all the possibly required dependencies.
 +
 +
The subpackage structure is as follows:
 +
* python-ipython-console: Provides the main console/config/core stuff, which you always need, when interacting with ipython.
 +
* python-ipython-gui: Provides the qtconsole and requires QT4
 +
* python-ipython-notebook: Provides the IPython Notebook, which currently requires python-tornado.
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
+
Fedora will ship the latest IPython, which has major features like new user interface of the notebook and many more magics. See the [http://ipython.org/ipython-doc/rel-0.13/whatsnew/version0.13.html Upstream Release Notes] for more information.
  
 
== Scope ==
 
== Scope ==
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
 +
The main changes takes place in the ipython package. Other packages depending on ipython will pull all ipython packages, when they require the "ipython" package, which might be unnecessary and waste disc space. This can be improved, when those package specificaly pull in those dependencies they need.
 +
 +
For a list of packages and description see Detailed Description above.
  
 
== How To Test ==
 
== How To Test ==
Line 46: Line 54:
 
3. What are the expected results of those actions?
 
3. What are the expected results of those actions?
 
-->
 
-->
 +
 +
* Install python-ipython-console and the standard ipython/ipcluster will work out of the box without the need to install huge dependencies like QT.
 +
* Install python-ipython-gui and the qtconsole works out of the box.
 +
* Install python-ipython-notebook and further test the [http://ipython.org/ipython-doc/rel-0.13/interactive/htmlnotebook.html notebook].
  
 
== User Experience ==
 
== User Experience ==
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
 
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
 +
Users will be impressed by the new functionality of the notebook and new magics implemented in this version of IPython.
  
 
== Dependencies ==
 
== Dependencies ==
 
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
 
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
 +
None.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
 +
None necessary, revert to old version/package structure.
  
 
== Documentation ==
 
== Documentation ==
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
 
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
*
+
* [http://ipython.org/ipython-doc/rel-0.13/whatsnew/version0.13.html Upstream Release Notes / Documentation]
  
 
== Release Notes ==
 
== Release Notes ==
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
*
+
IPython has been updated to version 0.13 and notable features and head-ups are:
 +
* The Notebook has a new user interface and has many new features like auto-folding of very long lines, uploading new notebooks to the dashboard, manage started clusters and improoved tooltips.
 +
* The notebook format has changed and when you want to share your notebook with users of older version, there is a conversion [https://gist.github.com/1935808 script] available.
 +
* New cell magics like %%bash, %%ruby, %%timeit and many others.
 +
* The Qt console has improved menus and can directly display jpeg images.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
Line 69: Line 88:
  
  
[[Category:FeaturePageIncomplete]]
+
<!-- [[Category:FeaturePageIncomplete]] -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
+
[[Category:FeatureAcceptedF18]]
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Latest revision as of 12:16, 9 October 2012


Contents

[edit] IPython 0.13

[edit] Summary

Update ipython to version 0.13 with reorganizing the package structure to better fit the new upstream structure.

[edit] Owner

[edit] Current status

  • Targeted release: Fedora 18
  • Last updated: 2012-10-09
  • Percentage of completion: 100%

[edit] Detailed Description

Update to the most recent IPython version 0.13 and package split it into subpackages, so one doesn't require to install all the possibly required dependencies.

The subpackage structure is as follows:

  • python-ipython-console: Provides the main console/config/core stuff, which you always need, when interacting with ipython.
  • python-ipython-gui: Provides the qtconsole and requires QT4
  • python-ipython-notebook: Provides the IPython Notebook, which currently requires python-tornado.

[edit] Benefit to Fedora

Fedora will ship the latest IPython, which has major features like new user interface of the notebook and many more magics. See the Upstream Release Notes for more information.

[edit] Scope

The main changes takes place in the ipython package. Other packages depending on ipython will pull all ipython packages, when they require the "ipython" package, which might be unnecessary and waste disc space. This can be improved, when those package specificaly pull in those dependencies they need.

For a list of packages and description see Detailed Description above.

[edit] How To Test

  • Install python-ipython-console and the standard ipython/ipcluster will work out of the box without the need to install huge dependencies like QT.
  • Install python-ipython-gui and the qtconsole works out of the box.
  • Install python-ipython-notebook and further test the notebook.

[edit] User Experience

Users will be impressed by the new functionality of the notebook and new magics implemented in this version of IPython.

[edit] Dependencies

None.

[edit] Contingency Plan

None necessary, revert to old version/package structure.

[edit] Documentation

[edit] Release Notes

IPython has been updated to version 0.13 and notable features and head-ups are:

  • The Notebook has a new user interface and has many new features like auto-folding of very long lines, uploading new notebooks to the dashboard, manage started clusters and improoved tooltips.
  • The notebook format has changed and when you want to share your notebook with users of older version, there is a conversion script available.
  • New cell magics like %%bash, %%ruby, %%timeit and many others.
  • The Qt console has improved menus and can directly display jpeg images.

[edit] Comments and Discussion