Skip to main content

To be Updated

Project description

Kernl Banner

PyPI Version Downloads Python Versions License

Overview

Kernl is a secure persistent development environment system for cloud based Linux/Unix instances, providing a VSCode Web workspace backed by cloud based dataset managers such as HuggingFace 🤗 and Kaggle to keep full codebases, configurations, virtual environments, and dependencies persistent in the cloud, while supporting connections to distributed version-control platforms including GitHub, GitLab, and Bitbucket for SSH access and seamless continuation of development work from the start.

Features

(1) Secure VSCode Web Workspace 🔐: Kernl provides a secure, password-protected VSCode Web workspace that offers a full development environment for cloud-based Linux/Unix instances. The workspace is exposed through ngrok tunneling and provides complete access to the VSCode interface.

(2) Cloud-backed Persistent Environment ☁️: Workspaces are managed by cloud dataset managers such as HuggingFace 🤗 and Kaggle, keeping full codebases, VSCode configurations, virtual environments, and dependencies consistently preserved and restorable across sessions. Environment storage uses fast tar-lz4 compression and decompression for quick upload and retrieval of workspace components.

(3) Integrated Version-Control Connectivity 🔗: Kernl supports connections to all major distributed version-control platforms including GitHub, GitLab, and Bitbucket. It enables authentication through platform tokens, allows adding and deleting SSH keys directly from Kernl, and provides seamless access to repositories for immediate development.

(4) Unified Remote Development Interface 🌐: Kernl allows you to push full environments to the cloud and pull them back whenever needed, enabling seamless continuation of work without occupying storage on the host machine, and allowing development to resume on any compatible cloud instance using the stored environments and connected distributed version-control platforms.

(5) API and CLI Availability 🧩: Kernl is accessible as both a Python API and a terminal-based CLI tool, allowing you to automate tasks programmatically or interact directly from the command line depending on your workflow.

Installation

kernl can be installed in two ways, either directly from PyPI for regular use or by cloning the repository if you want to modify the project or contribute. Before installing kernl, it is recommended to create a new virtual environment.

Create a Virtual Environment (Recommended)

uv venv venv --python 3.11
source venv/bin/activate

1. Install kernl from PyPI

uv pip install kernl

This installs kernl and makes the kernl API and CLI available on your Linux or Unix based system.

2. Install kernl from Source

git clone https://github.com/nnilayy/kernl.git
cd kernl
uv pip install -e .

Installing in editable mode means any changes you make to the source code will immediately apply when running kernl.

Contributing

Contributions are welcome! If you have suggestions, bug reports, or feature requests, feel free to open an issue or submit a pull request.

Steps to Contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure kernl runs as expected.
  4. Submit a pull request with a clear and detailed explanation of your updates.

License

This project is licensed under the GNU General Public License v3.0, check out the LICENSE file for more details.

Support & Contact

If you have any questions or need assistance, feel free to reach out:


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kernl-0.4.9.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kernl-0.4.9-py3-none-any.whl (39.5 kB view details)

Uploaded Python 3

File details

Details for the file kernl-0.4.9.tar.gz.

File metadata

  • Download URL: kernl-0.4.9.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for kernl-0.4.9.tar.gz
Algorithm Hash digest
SHA256 69ae595fda70c93070d5bf93bbda1280996e75ce5e5852e48634337230d2d842
MD5 a4776c6379697420d33e41c6d9843a59
BLAKE2b-256 589e65e532febc45b1711835c31e83649c017584aa0573b313753b04daa2bbee

See more details on using hashes here.

File details

Details for the file kernl-0.4.9-py3-none-any.whl.

File metadata

  • Download URL: kernl-0.4.9-py3-none-any.whl
  • Upload date:
  • Size: 39.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for kernl-0.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 02dd9b5cf72b02624c3b799054788306deb6e0868ad081c3c1d713921f495e19
MD5 fd5a00c4293d14a0031fad3f78f2516d
BLAKE2b-256 4052fa0dca6f806fa36131a9797dba281259a7b0aefe62dae563125996ea6c01

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page