Metadata-Version: 2.4
Name: kts-light-theme
Version: 0.1.1
Summary: KTS Light theme for JupyterLab
License: BSD 3-Clause License
        
        Copyright (c) 2024, Million Concepts
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Themes
Requires-Python: >=3.12
Requires-Dist: jupyterlab<5,>=4.0.0
Description-Content-Type: text/markdown

# kts_light_theme

Light theme for Knowing the Sky. Experimental, not yet for distribution.

## dev environment setup

Create a conda environment with at least:

* `jupyterlab>=4.3.1`
* `jupyterlab-myst`
* `python<3.14`
* `nodejs=22` (do **not** use your system node)

`make` is also required.

If you have the dependencies for Knowing The Sky installed, the only additional
requirement is `nodejs=22`.

Do **not** install `hatch-jupyter-builder`.

## dev installation

**initial**

run `make build && make install`. This will download all node dependencies,
perform an initial build of the extension, and symlink it to the central
Jupyter extensions directory. Now the extension should be available in 
JupyterLab, and changes you make to 
`kts_light_theme/labextension/themes/kts-light-theme/index.css` will appear 
in JupyterLab on page reload.

**rebuild**

If you want to ship changes to the theme, run `make rebuild`. This
will propagate changes from `kts_light_theme/labextension/themes/kts-light-theme/index.css`
into the non-editable ("regular") version of the extension.

**reinstall/relink**

If your links get messed up somehow such that you can't rebuild the
package or Jupyter can't find your editable CSS, run `make reinstall`.
Do not attempt to relink by directly reinstalling the package with `pip`.
The Lab extension build sequence will cause this to fail.

**full reinstall**

Run `make clean && make build && make install`.

### A note on PyCharm

The package includes ESLint configurations, which PyCharm will attempt to 
automatically use. It will probably fail unless you have all the correct
node packages and a compatible .stylelintrc available at system level. This will
create annoying error messages when editing many files. To fix this, you can 
either install them at system level or go to Settings/Stylelint and point it 
to the node module jlpm installed when you did the initial install:
`node_modules/stylelint` (relative to repo root)
