mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-04-21 10:15:45 +00:00
140 lines
5.4 KiB
Plaintext
140 lines
5.4 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: jupyter-client
|
|
Version: 7.3.1
|
|
Summary: Jupyter protocol implementation and client libraries
|
|
Home-page: https://jupyter.org
|
|
Author: Jupyter Development Team
|
|
Author-email: jupyter@googlegroups.com
|
|
License: BSD
|
|
Project-URL: Documentation, https://jupyter-client.readthedocs.io
|
|
Project-URL: Source, https://github.com/jupyter/jupyter_client/
|
|
Project-URL: Tracker, https://github.com/jupyter/jupyter_client/issues
|
|
Keywords: Interactive,Interpreter,Shell,Web
|
|
Platform: Linux
|
|
Platform: Mac OS X
|
|
Platform: Windows
|
|
Classifier: Framework :: Jupyter
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Intended Audience :: Education
|
|
Classifier: Intended Audience :: System Administrators
|
|
Classifier: Intended Audience :: Science/Research
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Requires-Python: >=3.7
|
|
Description-Content-Type: text/markdown
|
|
License-File: COPYING.md
|
|
Requires-Dist: entrypoints
|
|
Requires-Dist: jupyter-core (>=4.9.2)
|
|
Requires-Dist: nest-asyncio (>=1.5.4)
|
|
Requires-Dist: python-dateutil (>=2.8.2)
|
|
Requires-Dist: pyzmq (>=22.3)
|
|
Requires-Dist: tornado (>=6.0)
|
|
Requires-Dist: traitlets
|
|
Provides-Extra: doc
|
|
Requires-Dist: ipykernel ; extra == 'doc'
|
|
Requires-Dist: myst-parser ; extra == 'doc'
|
|
Requires-Dist: sphinx (>=1.3.6) ; extra == 'doc'
|
|
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
|
|
Requires-Dist: sphinxcontrib-github-alt ; extra == 'doc'
|
|
Provides-Extra: test
|
|
Requires-Dist: codecov ; extra == 'test'
|
|
Requires-Dist: coverage ; extra == 'test'
|
|
Requires-Dist: ipykernel (>=6.5) ; extra == 'test'
|
|
Requires-Dist: ipython ; extra == 'test'
|
|
Requires-Dist: mypy ; extra == 'test'
|
|
Requires-Dist: pre-commit ; extra == 'test'
|
|
Requires-Dist: pytest ; extra == 'test'
|
|
Requires-Dist: pytest-asyncio (>=0.18) ; extra == 'test'
|
|
Requires-Dist: pytest-cov ; extra == 'test'
|
|
Requires-Dist: pytest-timeout ; extra == 'test'
|
|
|
|
# Jupyter Client
|
|
|
|
[](https://github.com/jupyter/jupyter_client/actions)
|
|
[](https://github.com/psf/black)
|
|
|
|
`jupyter_client` contains the reference implementation of the [Jupyter protocol][].
|
|
It also provides client and kernel management APIs for working with kernels.
|
|
|
|
It also provides the `jupyter kernelspec` entrypoint
|
|
for installing kernelspecs for use with Jupyter frontends.
|
|
|
|
[jupyter protocol]: https://jupyter-client.readthedocs.io/en/latest/messaging.html
|
|
|
|
## Development Setup
|
|
|
|
The [Jupyter Contributor Guides](https://jupyter.readthedocs.io/en/latest/contributing/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.
|
|
|
|
## Coding
|
|
|
|
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`
|
|
|
|
```bash
|
|
cd /my/projects/
|
|
git clone git@github.com:jupyter/jupyter_client.git
|
|
```
|
|
|
|
Now create an [editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
|
|
and download the dependencies of code and test suite by executing:
|
|
|
|
```bash
|
|
cd /my/projects/jupyter_client/
|
|
pip install -e ".[test]"
|
|
pytest
|
|
```
|
|
|
|
The last command runs the test suite to verify the setup. During development, you can pass filenames to `pytest`, and it will execute only those tests.
|
|
|
|
## Documentation
|
|
|
|
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](https://jupyter.readthedocs.io/en/latest/contributing/docs-contributions/index.html). You'll also need the `make` command.
|
|
For a minimal Sphinx installation to process the Jupyter Client docs, execute:
|
|
|
|
```bash
|
|
pip install ".[doc]"
|
|
```
|
|
|
|
The following commands build the documentation in HTML format and check for broken links:
|
|
|
|
```bash
|
|
cd /my/projects/jupyter_client/docs/
|
|
make html linkcheck
|
|
```
|
|
|
|
Point your browser to the following URL to access the generated documentation:
|
|
|
|
_file:///my/projects/jupyter_client/docs/\_build/html/index.html_
|
|
|
|
## Contributing
|
|
|
|
`jupyter-client` has adopted automatic code formatting so you shouldn't
|
|
need to worry too much about your code style.
|
|
As long as your code is valid,
|
|
the pre-commit hook should take care of how it should look.
|
|
You can invoke the pre-commit hook by hand at any time with:
|
|
|
|
```bash
|
|
pre-commit run
|
|
```
|
|
|
|
which should run any autoformatting on your code
|
|
and tell you about any errors it couldn't fix automatically.
|
|
You may also install [black integration](https://black.readthedocs.io/en/stable/integrations/editors.html)
|
|
into your text editor to format code automatically.
|
|
|
|
If you have already committed files before setting up the pre-commit
|
|
hook with `pre-commit install`, you can fix everything up using
|
|
`pre-commit run --all-files`. You need to make the fixing commit
|
|
yourself after that.
|
|
|
|
Some of the hooks only run on CI by default, but you can invoke them by
|
|
running with the `--hook-stage manual` argument.
|
|
|
|
|