Skip to content

Commit

Permalink
update readme part4
Browse files Browse the repository at this point in the history
  • Loading branch information
iplitharas committed Oct 28, 2024
1 parent 9a1966c commit b957a13
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,12 @@ Options:
```

```bash
pycompile -i your_python_files --clean-source --engine nuitka
```


```bash
pycompile compile -i input_path --engine cython
pycompile compile -i your_python_files --clean-source --engine nuitka
```

![cython_compile.gif](data/cython_compile.gif) or

```bash
pycompile compile -i input_path --engine nuitka
```

After the compilation the `input` dir will have the following structure.
After the compilation the `input` dir will have the following structure.

```text
examples
Expand All @@ -85,6 +76,32 @@ examples

### Benchmark

```bash
Usage: pycompile benchmark [OPTIONS]

Run a memory and cpu benchmark.

Options:
-i, --input-path PATH Specify the file/folder input path
[required]
-e, --engine [cython|nuitka|both|none]
compiler wrapper(s) to be used for the
benchmark, defaults to `both`.
-t, --type [memory|cpu|both] type of benchmark to execute, defaults to
`both`.
-p, --profile_func_pattern TEXT
function name pattern for profiling,
defaults to `benchmark`. All the functions
with a name that matches this pattern will
be decorated with `@profile` from: `memory-
profiler`, in addition their module needs to
follow the pattern
(`something_prof_func_name.py` to be
excluded from compilation).
-v, --verbose verbose level
--help Show this message and exit.
```

It starts a `memory` and a `cpu` benchmark, starting with
* `python`,
* `cython` and,
Expand Down Expand Up @@ -122,7 +139,6 @@ pycompile dry_run -i ./src
![dry_run.gif](data/dry_run.gif)



### Local-development
For local development run the following command

Expand Down

0 comments on commit b957a13

Please sign in to comment.