Skip to content

Commit

Permalink
Update documentation, bump version to v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ikappaki committed Jul 31, 2024
1 parent 144ff87 commit a3bebf4
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
environment: release
permissions:
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
contents: write # github release upload

steps:
- uses: actions/checkout@v4
Expand All @@ -30,5 +31,9 @@ jobs:
pip install hatch
- name: Build package
run: hatch build
- name: Upload release artifacts
run: gh release upload ${{ github.event.release.tag_name }} dist/*.{tar.gz,whl}
env:
GH_TOKEN: ${{ github.token }}
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

## Unreleased

## 1.1.0

- Optimized output to stdout/stderr by removing proxy string intermediary.
- Improved Exception formatting (requires basilisp>=0.1.0b2).
- Improved Exception formatting (requires basilisp>=0.1.0b2)

## 1.0.0

Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
[![CI](https://github.com/ikappaki/basilisp-kernel/actions/workflows/test.yml/badge.svg)](https://github.com/ikappaki/basilisp-kernel/actions/workflows/test.yml)

# Basilisp Kernel for Jupyter

Welcome to the Basilisp Kernel for Jupyter! This kernel allows you to run Basilisp code directly in your Jupyter notebooks.

Basilisp is a dialect Lisp compatible with Clojure, implemented in Python, that brings the expressiveness of Lisp to the python community. With the Basilisp Kernel, you can combine Lisp's powerful macro system with the extensive ecosystem of Python's scientific computing tools.
[Basilisp](https://github.com/basilisp-lang/basilisp) is a Python-based Lisp implementation that offers broad compatibility with Clojure.

## Features

- Full integration with Jupyter Notebook and JupyterLab
- Enhanced autocompletion features
- Ability to use Basilisp's macros and special forms in notebooks
- Seamless interoperability with Python libraries

## Installation
Expand Down Expand Up @@ -45,6 +46,8 @@ For full documentation on Basilisp, visit [Basilisp Documentation](https://basil

This project includes a series of Jupyter notebooks that demonstrate various features and capabilities. You can find these notebooks in the [notebooks](notebooks) directory of this repository.

![notebook plotting example](notebooks/nb-plot.png)

## Acknowledgments

This kernel was developed based on the [echo_kernel](https://github.com/jupyter/echo_kernel) as a starting point.
Expand Down
2 changes: 1 addition & 1 deletion basilisp_kernel/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""The Basilisp Jupyter kernel"""

__version__ = '1.0.0'
__version__ = '1.1.0'

from .kernel import BasilispKernel
Binary file added notebooks/nb-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3bebf4

Please sign in to comment.