-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
25 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,7 @@ Due to the differences between Python and the reference implementation languages | |
+ [The result type and multiple top-level variables](#the-result-type-and-multiple-top-level-variables) | ||
+ [Defining goal constructors](#defining-goal-constructors) | ||
- [Recursive goal constructors and `snooze` (Zzz)](#recursive-goal-constructors-and--snooze---zzz-) | ||
* [Developing microkanren](#developing-microkanren) | ||
|
||
## Installation | ||
|
||
|
@@ -146,6 +147,22 @@ We provide `snooze` to delay the construction of a goal until it is needed. Usin | |
'🍕' | ||
``` | ||
|
||
## Developing microkanren | ||
|
||
`microkanren` currently requires Python 3.11. | ||
|
||
1. `git clone [email protected]:jams2/microkanren.git` | ||
2. `pip install -e .[dev,testing]` | ||
|
||
Run the tests with `pytest`. | ||
|
||
Format code with `black` and `ruff`: | ||
|
||
``` bash | ||
black . | ||
ruff check --fix src tests | ||
``` | ||
|
||
--- | ||
|
||
[^1]: [μKanren: A Minimal Functional Core for Relational Programming (Hemann & Friedman, 2013)](http://webyrd.net/scheme-2013/papers/HemannMuKanren2013.pdf) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[project] | ||
name = "microkanren" | ||
version = "0.2.2" | ||
version = "0.3.0" | ||
authors = [ | ||
{ name="Joshua Munn", email="[email protected]" }, | ||
] | ||
|
@@ -9,6 +9,7 @@ readme = "README.md" | |
requires-python = "~=3.11" | ||
classifiers = [ | ||
"Programming Language :: Python :: 3", | ||
"Programming Language :: Python :: 3.11", | ||
"License :: OSI Approved :: MIT License", | ||
"Operating System :: OS Independent", | ||
"Development Status :: 2 - Pre-Alpha", | ||
|
@@ -17,6 +18,7 @@ dependencies = [ | |
"pyrsistent ~= 0.19", | ||
"fastcons ~= 0.2.0", | ||
] | ||
license = {file = "LICENSE"} | ||
|
||
[project.urls] | ||
"Homepage" = "https://github.com/jams2/microkanren" | ||
|
@@ -40,6 +42,7 @@ minversion = 7.0 | |
[tool.ruff] | ||
line-length = 88 | ||
src = ["src", "tests"] | ||
target-version = "py311" | ||
select = [ | ||
"E", # pycodestyle | ||
"F", # pyflakes | ||
|
@@ -50,7 +53,10 @@ select = [ | |
"T10", # flake8-debugger | ||
"C4", # flake8-comprehensions | ||
] | ||
unfixable = [ | ||
"ARG", # unused arguments | ||
] | ||
|
||
[tool.pyright] | ||
pythonVersion = "3.10" | ||
pythonVersion = "3.11" | ||
stubPath = "" |