-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FEAT: Upgrade to poetry packaging and examples 🎶
- Loading branch information
1 parent
e824b6a
commit 4f0d499
Showing
195 changed files
with
9,505 additions
and
543 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
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
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
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
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,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. | ||
|
||
|
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,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. | ||
|
||
|
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,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. | ||
|
||
|
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,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 | ||
|
||
|
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,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. | ||
|
||
|
Oops, something went wrong.