METADATA 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. Metadata-Version: 2.1
  2. Name: jupyterlab_pygments
  3. Version: 0.3.0
  4. Summary: Pygments theme using JupyterLab CSS variables
  5. Project-URL: Homepage, https://github.com/jupyterlab/jupyterlab_pygments
  6. Project-URL: Bug Tracker, https://github.com/jupyterlab/jupyterlab_pygments/issues
  7. Project-URL: Repository, https://github.com/jupyterlab/jupyterlab_pygments.git
  8. Author-email: Jupyter Development Team <jupyter@googlegroups.com>
  9. License: Copyright (c) 2015 Project Jupyter Contributors
  10. All rights reserved.
  11. Redistribution and use in source and binary forms, with or without
  12. modification, are permitted provided that the following conditions are met:
  13. 1. Redistributions of source code must retain the above copyright notice, this
  14. list of conditions and the following disclaimer.
  15. 2. Redistributions in binary form must reproduce the above copyright notice,
  16. this list of conditions and the following disclaimer in the documentation
  17. and/or other materials provided with the distribution.
  18. 3. Neither the name of the copyright holder nor the names of its
  19. contributors may be used to endorse or promote products derived from
  20. this software without specific prior written permission.
  21. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24. DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  25. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31. License-File: LICENSE
  32. Classifier: Framework :: Jupyter
  33. Classifier: Framework :: Jupyter :: JupyterLab
  34. Classifier: Framework :: Jupyter :: JupyterLab :: 4
  35. Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
  36. Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
  37. Classifier: License :: OSI Approved :: BSD License
  38. Classifier: Programming Language :: Python
  39. Classifier: Programming Language :: Python :: 3
  40. Classifier: Programming Language :: Python :: 3.8
  41. Classifier: Programming Language :: Python :: 3.9
  42. Classifier: Programming Language :: Python :: 3.10
  43. Classifier: Programming Language :: Python :: 3.11
  44. Classifier: Programming Language :: Python :: 3.12
  45. Requires-Python: >=3.8
  46. Description-Content-Type: text/markdown
  47. # JupyterLab Pygments Theme
  48. This package contains a syntax coloring theme for [pygments](http://pygments.org/) making use of
  49. the JupyterLab CSS variables.
  50. The goal is to enable the use of JupyterLab's themes with pygments-generated HTML.
  51. ## Screencast
  52. In the following screencast, we demonstrate how Pygments-highlighted code can make use of the JupyterLab theme.
  53. ![pygments screencast](pygments.gif)
  54. ## Installation
  55. `jupyterlab_pygments` can be installed with the conda package manager
  56. ```
  57. conda install -c conda-forge jupyterlab_pygments
  58. ```
  59. or from pypi
  60. ```
  61. pip install jupyterlab_pygments
  62. ```
  63. ## Dependencies
  64. - `jupyterlab_pygments` requires [pygments](http://pygments.org) version `2.4.1`.
  65. - The CSS variables used by the theme correspond to the CodeMirror syntex coloring
  66. theme defined in the NPM package [@jupyterlab/codemirror](https://www.npmjs.com/package/@jupyterlab/codemirror). Supported versions for `@jupyterlab/codemirror`'s CSS include `0.19.1`, `^1.0`, and, `^2.0`.
  67. ## Limitations
  68. Pygments-generated HTML and CSS classes are not granular enough to reproduce
  69. all of the details of codemirror (the JavaScript text editor used by JupyterLab).
  70. This includes the ability to differentiate properties from general names.
  71. ## License
  72. `jupyterlab_pygments` uses a shared copyright model that enables all contributors to maintain the
  73. copyright on their contributions. All code is licensed under the terms of the revised [BSD license](LICENSE).