FEAT: Upgrade to poetry packaging and examples 🎶

.bumpversion.cfg

@@ -1,9 +1,9 @@
 [bumpversion]
-current_version = 0.0.55
+current_version = 0.0.56
 commit = True
 tag = True
 
-[bumpversion:file:setup.py]
+[bumpversion:file:pyproject.toml]
 search = "{current_version}"
 replace = "{new_version}"
 

.gitignore

@@ -64,6 +64,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+_docs/
 
 # PyBuilder
 target/
@@ -198,3 +199,4 @@ RUN_*
 *.raw
 
 *.sif
+.idea/

MANIFEST.in

@@ -7,5 +7,7 @@ include README.rst
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
+recursive-exclude * environment
+recursive-exclude * openlane_run
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

docs/autoapi/index.rst

@@ -8,4 +8,4 @@ This page contains auto-generated API reference documentation [#f1]_.
 
    /autoapi/piel/index
 
-.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

docs/autoapi/piel/cli/core/index.rst

@@ -0,0 +1,24 @@
+:py:mod:`piel.cli.core`
+=======================
+
+.. py:module:: piel.cli.core
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   piel.cli.core.get_piel_install_directory
+
+
+
+.. py:function:: get_piel_install_directory()
+
+   Gets the piel installation directory.
+
+

docs/autoapi/piel/cli/develop/index.rst

@@ -0,0 +1,46 @@
+:py:mod:`piel.cli.develop`
+==========================
+
+.. py:module:: piel.cli.develop
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   piel.cli.develop.develop
+   piel.cli.develop.build_documentation
+   piel.cli.develop.generate_poetry2nix_flake
+   piel.cli.develop.build_piel_cachix_command
+
+
+
+.. py:function:: develop()
+
+   Development related commands.
+
+
+.. py:function:: build_documentation(args=None)
+
+   Verifies and builds the documentation.
+
+
+.. py:function:: generate_poetry2nix_flake(args=None)
+
+   Generates the poetry2nix flakes file. Requires nix to be installed.
+
+   Returns:
+
+
+
+.. py:function:: build_piel_cachix_command(args=None)
+
+   Enters the custom piel nix environment with all the supported tools installed and configured packages.
+   Runs the nix-shell command on the piel/environment/nix/ directory.
+
+

docs/autoapi/piel/cli/environment/environment/index.rst

@@ -0,0 +1,24 @@
+:py:mod:`piel.cli.environment.environment`
+==========================================
+
+.. py:module:: piel.cli.environment.environment
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   piel.cli.environment.environment.environment
+
+
+
+.. py:function:: environment()
+
+   Environment related commands.
+
+

docs/autoapi/piel/cli/environment/index.rst

@@ -0,0 +1,63 @@
+:py:mod:`piel.cli.environment`
+==============================
+
+.. py:module:: piel.cli.environment
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   environment/index.rst
+   nix/index.rst
+   venv/index.rst
+
+
+Package Contents
+----------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   piel.cli.environment.install_nix
+   piel.cli.environment.install_openlane
+   piel.cli.environment.activate_openlane_nix
+   piel.cli.environment.activate_piel_nix
+   piel.cli.environment.create_and_activate_venv
+
+
+
+.. py:function:: install_nix()
+
+   Installs the nix package manager.
+
+
+.. py:function:: install_openlane(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   CLI that installs both the openlane2 python interface and the OpenROAD binaries.
+
+
+.. py:function:: activate_openlane_nix(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   CLI that installs both the openlane2 python interface and the OpenROAD binaries.
+
+
+.. py:function:: activate_piel_nix(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   Enters the custom piel nix environment with all the supported tools installed and configured packages.
+   Runs the nix-shell command on the piel/environment/nix/ directory.
+
+
+.. py:function:: create_and_activate_venv() -> None
+
+   Creates and activates the piel virtual environment.
+
+   :returns: None.
+   :rtype: None
+
+

docs/autoapi/piel/cli/environment/nix/index.rst

@@ -0,0 +1,43 @@
+:py:mod:`piel.cli.environment.nix`
+==================================
+
+.. py:module:: piel.cli.environment.nix
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   piel.cli.environment.nix.activate_openlane_nix
+   piel.cli.environment.nix.activate_piel_nix
+   piel.cli.environment.nix.install_nix
+   piel.cli.environment.nix.install_openlane
+
+
+
+.. py:function:: activate_openlane_nix(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   CLI that installs both the openlane2 python interface and the OpenROAD binaries.
+
+
+.. py:function:: activate_piel_nix(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   Enters the custom piel nix environment with all the supported tools installed and configured packages.
+   Runs the nix-shell command on the piel/environment/nix/ directory.
+
+
+.. py:function:: install_nix()
+
+   Installs the nix package manager.
+
+
+.. py:function:: install_openlane(openlane2_directory: pathlib.Path = default_openlane2_directory)
+
+   CLI that installs both the openlane2 python interface and the OpenROAD binaries.
+
+