The following instruction are using PIP (Package Installer for Python) as a package manager and PyPI (Python Package Index) as a source of Python packages.
Users of pyTooling can select if the want to install a basic variant of pyTooling. See DEP
for more details.
Linux/MacOS
# Basic sphinx-reports package
pip3 install pyVHDLModel
Windows
# Basic sphinx-reports package
pip install pyVHDLModel
Developers can install further dependencies for documentation generation (doc
) or running unit tests (test
) or just all (all
) dependencies.
Linux/MacOS
With Documentation Dependencies
# Install with dependencies to generate documentation
pip3 install pyVHDLModel[doc]
With Unit Testing Dependencies
# Install with dependencies to run unit tests
pip3 install pyVHDLModel[test]
All Developer Dependencies
# Install with all developer dependencies
pip install pyVHDLModel[all]
Windows
With Documentation Dependencies
# Install with dependencies to generate documentation
pip install pyVHDLModel[doc]
With Unit Testing Dependencies
# Install with dependencies to run unit tests
pip install pyVHDLModel[test]
All Developer Dependencies
# Install with all developer dependencies
pip install pyVHDLModel[all]
Linux/MacOS
pip install -U pyVHDLModel
Windows
pip3 install -U pyVHDLModel
Linux/MacOS
pip uninstall pyVHDLModel
Windows
pip3 uninstall pyVHDLModel
See sections above on how to use PIP.
setup.py install
For development and bug fixing it might be handy to create a local wheel package and also install it locally on the development machine. The following instructions will create a local wheel package (*.whl
) and then use PIP to install it. As a user might have a sphinx-reports installation from PyPI, it's recommended to uninstall any previous sphinx-reports packages. (This step is also needed if installing an updated local wheel file with same version number. PIP will not detect a new version and thus not overwrite/reinstall the updated package contents.)
Ensure packaging requirements <DEP/packaging>
are installed.
Linux/MacOS
cd <sphinx-reports>
# Package the code in a wheel (*.whl)
python -m build --wheel
# Uninstall the old package
python -m pip uninstall -y pyVHDLModel
# Install from wheel
python -m pip install ./dist/pyVHDLModel-0.28.0-py3-none-any.whl
Windows
cd <sphinx-reports>
# Package the code in a wheel (*.whl)
py -m build --wheel
# Uninstall the old package
py -m pip uninstall -y pyVHDLModel
# Install from wheel
py -m pip install .\dist\pyVHDLModel-0.28.0-py3-none-any.whl