Metadata-Version: 2.4
Name: pipeshift-jupyterlab-theme
Version: 0.1.0
Summary: Pipeshift custom themes for JupyterLab
Project-URL: Homepage, https://github.com/pipeshift/pipeshift-jupyterlab-theme
Project-URL: Bug-Reports, https://github.com/pipeshift/pipeshift-jupyterlab-theme/issues
Project-URL: Repository, https://github.com/pipeshift/pipeshift-jupyterlab-theme.git
Author-email: Pipeshift <info@pipeshift.com>
License: MIT License
        
        Copyright (c) 2025 Pipeshift
        
        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,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.8
Requires-Dist: jupyterlab<5,>=4.4.5
Description-Content-Type: text/markdown

# Pipeshift JupyterLab Theme

A custom theme extension for JupyterLab featuring both light and dark modes with Pipeshift branding.

## Features

- **Two Theme Variants**: 
  - Pipeshift Light - Clean, modern light theme
  - Pipeshift Dark - Elegant dark theme optimized for long coding sessions
- **Inter Font Integration**: Modern, readable typography
- **Customizable CSS Variables**: Organized by component for easy modification
- **JupyterLab 4.4.5+ Compatible**: Built for the latest JupyterLab versions
- **Easy Installation**: Available via pip

## Installation

### Via pip (Recommended)

```bash
pip install pipeshift-jupyterlab-theme
```

### From Source

```bash
git clone https://github.com/pipeshift/pipeshift-jupyterlab-theme.git
cd pipeshift-jupyterlab-theme
pip install -e .
```

## Usage

1. After installation, restart JupyterLab
2. Go to **Settings** → **Theme**
3. Select either:
   - **Pipeshift Light** for light mode
   - **Pipeshift Dark** for dark mode

## Theme Colors

### Brand Colors
- **Accent Color**: `#8A38F5` (Pipeshift Purple)

### Light Theme
- **Primary Background**: `#FFFFFF`
- **Primary Text**: `#181D27`
- **Border Color**: `#616161`

### Dark Theme
- **Primary Background**: `#131314`
- **Primary Text**: `#ECECED`
- **Border Color**: `#898989`

## Customization

The theme is built with CSS custom properties (variables) organized by component. You can easily customize colors by overriding these variables:

### Core Variables (in `style/variables.css`)

```css
:root {
  /* Brand Colors */
  --ps-accent-color: #8A38F5;
  --ps-accent-hover: #7A2FE5;
  --ps-accent-active: #6A26D5;
  
  /* Typography */
  --ps-font-family: 'Inter', sans-serif;
  --ps-font-size-base: 13px;
  /* ... and many more */
}
```

### Component-Specific Variables

The theme includes organized variables for:

- **Notebook Cells**: `--ps-cell-*`
- **File Browser**: `--ps-filebrowser-*`
- **Terminal**: `--ps-terminal-*`
- **Toolbar**: `--ps-toolbar-*`
- **Menus**: `--ps-menu-*`
- **Status Bar**: `--ps-statusbar-*`
- **Tabs**: `--ps-tab-*`
- **Sidebar**: `--ps-sidebar-*`
- **Code Editor**: `--ps-editor-*`

## Development

### Prerequisites

- Node.js 18+
- Python 3.8+
- JupyterLab 4.4.5+

### Setup

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

# Install dependencies
npm install

# Install the package in development mode
pip install -e .

# Build and link the extension
npm run build
jupyter labextension develop . --overwrite
```

### Development Workflow

```bash
# Watch for changes and rebuild
npm run watch

# In another terminal, start JupyterLab
jupyter lab --watch
```

### Building for Production

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

# Build production version
npm run build:prod

# Build Python package
python -m build
```

## File Structure

```
pipeshift-jupyterlab-theme/
├── src/
│   └── index.ts              # TypeScript entry point
├── style/
│   ├── index.css             # Main CSS entry point
│   ├── variables.css         # CSS custom properties
│   ├── light.css             # Pipeshift Light theme
│   └── dark.css              # Pipeshift Dark theme
├── package.json              # NPM package configuration
├── pyproject.toml            # Python package configuration
├── tsconfig.json             # TypeScript configuration
└── install.json              # JupyterLab installation metadata
```

## Browser Support

- Chrome/Chromium 88+
- Firefox 85+
- Safari 14+
- Edge 88+

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

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

## Changelog

### v0.1.0 (Initial Release)
- Pipeshift Light theme
- Pipeshift Dark theme
- Inter font integration
- Comprehensive CSS variable system
- JupyterLab 4.4.5+ compatibility

## Support

For issues and feature requests, please use the [GitHub Issues](https://github.com/pipeshift/pipeshift-jupyterlab-theme/issues) page.

---

Made with ❤️ by Pipeshift