Metadata-Version: 2.4
Name: jupyterlab-nord-theme
Version: 0.1.1
Summary: An arctic, north-bluish clean and elegant JupyterLab theme based on the Nord color palette
Project-URL: Homepage, https://github.com/carlyou/jupyterlab-nord-theme
Project-URL: Bug-Tracker, https://github.com/carlyou/jupyterlab-nord-theme/issues
Project-URL: Repository, https://github.com/carlyou/jupyterlab-nord-theme.git
Author-email: carlyou <carlyou@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2024 JupyterLab Nord Theme Contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: Jupyter,JupyterLab,JupyterLab4,Nord,theme
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Requires-Dist: jupyterlab<5,>=4.0.0
Description-Content-Type: text/markdown

# JupyterLab Nord Theme

An arctic, north-bluish clean and elegant JupyterLab theme based on the [Nord color palette](https://www.nordtheme.com/).

![JupyterLab version](https://img.shields.io/badge/JupyterLab-4.0+-blue.svg)
![PyPI](https://img.shields.io/pypi/v/jupyterlab-nord-theme)
![License](https://img.shields.io/badge/License-MIT-green.svg)

## Preview

![JupyterLab Nord Theme Screenshot](screenshot.png)

## Features

- **Nord Color Palette**: Authentic implementation of the 16-color Nord palette
- **Dark Theme**: Designed for comfortable coding in low-light environments  
- **Complete Coverage**: Themes all JupyterLab components including notebooks, file browser, terminals, and settings
- **Syntax Highlighting**: Beautiful Nord-based syntax highlighting for code cells
- **Perfect Compatibility**: Built using JupyterLab 4.0+ CSS variable system for full compatibility
- **Font Scaling Support**: Respects JupyterLab's font scaling settings
- **Layout Preservation**: Uses exact default theme layout and sizing, only changes colors

## Color Palette

This theme uses the official Nord color palette with custom auxiliary colors for enhanced readability:

### Polar Night (Dark Backgrounds)
- `nord0` - `#2e3440` - Darkest background
- `nord1` - `#3b4252` - Dark background
- `nord2` - `#434c5e` - Medium background
- `nord3` - `#4c566a` - Light background

### Snow Storm (Light Text)
- `nord4` - `#d8dee9` - Dark foreground
- `nord5` - `#e5e9f0` - Medium foreground
- `nord6` - `#eceff4` - Light foreground

### Frost (Blue Accents)
- `nord7` - `#8fbcbb` - Calm accent
- `nord8` - `#88c0d0` - Bright accent
- `nord9` - `#81a1c1` - Medium accent
- `nord10` - `#5e81ac` - Dark accent

### Aurora (Vibrant Colors)
- `nord11` - `#bf616a` - Red (errors)
- `nord12` - `#d08770` - Orange
- `nord13` - `#ebcb8b` - Yellow (warnings)
- `nord14` - `#a3be8c` - Green (success)
- `nord15` - `#b48ead` - Purple

### Custom Auxiliary Colors
- `nord-aux-comment` - `#8a9199` - Optimized comment color for better readability

## Installation

### From PyPI (Recommended)

```bash
pip install jupyterlab-nord-theme
```

### From Source

```bash
# Clone the repository
git clone https://github.com/carlyou/jupyterlab-nord-theme.git
cd jupyterlab-nord-theme

# Install in development mode
pip install -e .
```

## Usage

1. Install the extension using one of the methods above
2. Launch JupyterLab: `jupyter lab`
3. Go to **Settings** → **Theme** → **Nord Theme**
4. The theme will be applied immediately

## Development

### Requirements

- Python >= 3.8
- Node.js >= 16
- JupyterLab >= 4.0

### Setup Development Environment

```bash
# Clone the repository
git clone https://github.com/carlyou/jupyterlab-nord-theme.git
cd jupyterlab-nord-theme

# Install Python dependencies
pip install -e .

# Install Node.js dependencies
npm install

# Build in development mode
npm run build

# Install for development
jupyter labextension develop . --overwrite
```

### Making Changes

1. Edit CSS variables in `style/index.css`
2. Modify TypeScript registration in `src/index.ts` 
3. Rebuild: `npm run build`
4. Refresh JupyterLab to see changes

### Project Structure

```
jupyterlab-nord-theme/
├── src/                    # TypeScript source code
│   └── index.ts           # Extension registration
├── style/                 # CSS theme files
│   ├── index.css         # Main theme CSS with Nord variables
│   └── index.js          # Style module entry point
├── jupyterlab_nord_theme/ # Python package
│   ├── __init__.py       # Extension metadata
│   └── labextension/     # Built extension files
├── package.json          # Node.js configuration
├── pyproject.toml        # Python packaging configuration
├── tsconfig.json         # TypeScript configuration
└── README.md            # This file
```

## Building for Production

```bash
# Clean previous builds
npm run clean:all

# Build production version
npm run build:prod
```

## Publishing

### PyPI

```bash
# Build package
pip install build
python -m build

# Upload to PyPI
pip install twine
twine upload dist/*
```

### npm (for developers)

```bash
npm publish
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

### Guidelines

- Follow the existing code style
- Test your changes thoroughly
- Update documentation as needed
- Add appropriate commit messages

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- [Nord Theme](https://www.nordtheme.com/) by Arctic Ice Studio for the beautiful color palette
- [JupyterLab](https://github.com/jupyterlab/jupyterlab) team for the excellent extension system
- The JupyterLab community for inspiration and best practices

## Related Projects

- [Nord VSCode](https://github.com/arcticicestudio/nord-visual-studio-code)
- [Nord Vim](https://github.com/arcticicestudio/nord-vim)
- [Nord Terminal](https://github.com/arcticicestudio/nord-terminal-app)