-
Notifications
You must be signed in to change notification settings - Fork 2
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
0 parents
commit 0e947ec
Showing
70 changed files
with
8,301 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 581a6525e50ddc774ffb160a9b79abdb | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file.
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 |
---|---|---|
@@ -0,0 +1,89 @@ | ||
.. pycompile documentation master file, created by | ||
sphinx-quickstart on Tue Jun 27 13:08:22 2023. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Welcome to pycompile's docs! | ||
===================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
CLI | ||
|
||
Contents | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
|
||
|
||
|
||
CLI | ||
================== | ||
1. `compile <#compile>`__ | ||
2. `benchmark <#benchmark>`__ | ||
3. `dry run <#dry-run>`__ | ||
|
||
|
||
================= | ||
compile | ||
================= | ||
|
||
.. code:: bash | ||
pycompile -i your_python_files --clean-source --engine nuitka | ||
By default, the `Cython <https://cython.org/>`__ is being used as the | ||
default compiler. | ||
|
||
For compiling the ``examples`` use the following command: | ||
|
||
.. code:: bash | ||
pycompile -i input_path --engine cython | ||
which by default, deletes any temp build files and keeps the source | ||
files. | ||
|
||
.. code:: bash | ||
pycompile -i input_path --engine nuitka | ||
After the compilation the ``input`` dir will have the following | ||
structure. | ||
|
||
.. code:: text | ||
examples | ||
├── fib.py.py | ||
├── fib.cpython-310-darwin.so | ||
├── test_fib.py | ||
Benchmark | ||
~~~~~~~~~ | ||
|
||
For running a benchmark on the ``input-path`` use the following command: | ||
|
||
.. code:: bash | ||
pycompile benchmark -i src/examples -vvv | ||
Dry run | ||
~~~~~~~ | ||
|
||
.. code:: bash | ||
pycompile dry_run -i ./src | ||
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src | ||
=== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
src |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.benchmark module | ||
==================== | ||
|
||
.. automodule:: src.benchmark | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.cli.benchmark\_cmd module | ||
============================= | ||
|
||
.. automodule:: src.cli.benchmark_cmd | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.cli.compile\_cmd module | ||
=========================== | ||
|
||
.. automodule:: src.cli.compile_cmd | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.cli.dry\_run\_cmd module | ||
============================ | ||
|
||
.. automodule:: src.cli.dry_run_cmd | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.cli.entrypoint module | ||
========================= | ||
|
||
.. automodule:: src.cli.entrypoint | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
src.cli package | ||
=============== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
src.cli.benchmark_cmd | ||
src.cli.compile_cmd | ||
src.cli.dry_run_cmd | ||
src.cli.entrypoint | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: src.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.compiler\_handler module | ||
============================ | ||
|
||
.. automodule:: src.compiler_handler | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.file\_handler module | ||
======================== | ||
|
||
.. automodule:: src.file_handler | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.helpers module | ||
================== | ||
|
||
.. automodule:: src.helpers | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.logging\_setup module | ||
========================= | ||
|
||
.. automodule:: src.logging_setup | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
src package | ||
=========== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
src.benchmark | ||
src.compiler_handler | ||
src.file_handler | ||
src.helpers | ||
src.logging_setup | ||
src.wrappers | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: src | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
src.wrappers module | ||
=================== | ||
|
||
.. automodule:: src.wrappers | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.