Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tusharsadhwani authored Nov 20, 2023
1 parent 1975fad commit acd84db
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ difference in speed:

[1]: ./compiled_examples/hashes.py

## How does it work?

It uses this awesome piece of software called [mypyc](https://github.com/mypyc/mypyc)
which takes type-checked Python code and compiles it to C code, which is generally
faster.

Simply making sure that the Python module is statically type checked is 95% of the
work needed to be done to make the project work. The rest is just glue code to test
the compiled code and package it.

### Help wanted!

Currently only two modules have been migrated: `tomllib` and `difflib`.

PRs type checking other Python modules are welcome!

## Local Development / Testing

- Create and activate a virtual environment.
Expand Down

0 comments on commit acd84db

Please sign in to comment.