METADATA 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. Metadata-Version: 2.1
  2. Name: jupyter-client
  3. Version: 5.3.5
  4. Summary: Jupyter protocol implementation and client libraries
  5. Home-page: https://jupyter.org
  6. Author: Jupyter Development Team
  7. Author-email: jupyter@googlegroups.com
  8. License: BSD
  9. Project-URL: Documentation, https://jupyter-client.readthedocs.io
  10. Project-URL: Source, https://github.com/jupyter/jupyter_client/
  11. Project-URL: Tracker, https://github.com/jupyter/jupyter_client/issues
  12. Keywords: Interactive,Interpreter,Shell,Web
  13. Platform: Linux
  14. Platform: Mac OS X
  15. Platform: Windows
  16. Classifier: Framework :: Jupyter
  17. Classifier: Intended Audience :: Developers
  18. Classifier: Intended Audience :: Education
  19. Classifier: Intended Audience :: System Administrators
  20. Classifier: Intended Audience :: Science/Research
  21. Classifier: License :: OSI Approved :: BSD License
  22. Classifier: Operating System :: OS Independent
  23. Classifier: Programming Language :: Python
  24. Classifier: Programming Language :: Python :: 2
  25. Classifier: Programming Language :: Python :: 3
  26. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
  27. Description-Content-Type: text/markdown
  28. Requires-Dist: jupyter-core (>=4.6.0)
  29. Requires-Dist: python-dateutil (>=2.1)
  30. Requires-Dist: pyzmq (>=13)
  31. Requires-Dist: tornado (>=4.1)
  32. Requires-Dist: traitlets
  33. Requires-Dist: pywin32 (>=1.0) ; sys_platform == "win32"
  34. Provides-Extra: test
  35. Requires-Dist: ipykernel ; extra == 'test'
  36. Requires-Dist: ipython ; extra == 'test'
  37. Requires-Dist: mock ; extra == 'test'
  38. Requires-Dist: pytest ; extra == 'test'
  39. # Jupyter Client
  40. [![Code Health](https://landscape.io/github/jupyter/jupyter_client/master/landscape.svg?style=flat)](https://landscape.io/github/jupyter/jupyter_client/master)
  41. `jupyter_client` contains the reference implementation of the [Jupyter protocol][].
  42. It also provides client and kernel management APIs for working with kernels.
  43. It also provides the `jupyter kernelspec` entrypoint
  44. for installing kernelspecs for use with Jupyter frontends.
  45. [Jupyter protocol]: https://jupyter-client.readthedocs.io/en/latest/messaging.html
  46. # Development Setup
  47. The [Jupyter Contributor Guides](http://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html) provide extensive information on contributing code or documentation to Jupyter projects. The limited instructions below for setting up a development environment are for your convenience.
  48. ## Coding
  49. You'll need Python and `pip` on the search path. Clone the Jupyter Client git repository to your computer, for example in `/my/project/jupyter_client`.
  50. Now create an [editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
  51. and download the dependencies of code and test suite by executing:
  52. cd /my/projects/jupyter_client/
  53. pip install -e .[test]
  54. py.test
  55. The last command runs the test suite to verify the setup. During development, you can pass filenames to `py.test`, and it will execute only those tests.
  56. ## Documentation
  57. The documentation of Jupyter Client is generated from the files in `docs/` using Sphinx. Instructions for setting up Sphinx with a selection of optional modules are in the [Documentation Guide](http://jupyter.readthedocs.io/en/latest/contrib_docs/index.html). You'll also need the `make` command.
  58. For a minimal Sphinx installation to process the Jupyter Client docs, execute:
  59. pip install ipykernel sphinx sphinx_rtd_theme
  60. The following commands build the documentation in HTML format and check for broken links:
  61. cd /my/projects/jupyter_client/docs/
  62. make html linkcheck
  63. Point your browser to the following URL to access the generated documentation:
  64. _file:///my/projects/jupyter\_client/docs/\_build/html/index.html_