Skip to content

Commit

Permalink
added classifier and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nucccc committed May 9, 2024
1 parent 5ff55eb commit 85d9db7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,22 @@ def stuff(a : int, b : int, c : float = 0.4, d = None) -> int:

## Installation

At the moment there is no PyPI package, so if someone really (really?) wants to run such thing, the repo should be cloned, to then run the `setup.py` script in the cloning folder
Markarth is available on the [PyPI index](https://pypi.org/project/markarth). You can install it using pip:

```
git clone https://github.com/nucccc/markarth
cd markarth
pip install .
pip install markarth
```

## Internal functioning

It makes heavy usage of the `ast` module in order to parse python code, while leveraging type annotations to infer variable types, thus adding some declarations that with python would speed the code up.

The module's functionality is divided in two main steps:
- one in which the code parsed with `ast` is analyzed to detect types of variables. Results of elementary operations are used, together with invocations of functions like `len()`.
- another in which the types collected are converted to cython codelines.

There are additional functionalities to provide conversion options, in order to use `cython.double` instead of `cython.float` as type during conversion.

## Possible improvements

Several possible improvements can be done (apart from testing and discovering bugs, obviously). Among them:
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
'coverage >= 7.3.2'
],
classifiers=[
'Intended Audience :: Developers'
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
Expand Down

0 comments on commit 85d9db7

Please sign in to comment.