Skip to content

Commit

Permalink
v0.13.1
Browse files Browse the repository at this point in the history
  • Loading branch information
umarcor committed Sep 27, 2021
2 parents 14cb999 + a754188 commit 140fd19
Show file tree
Hide file tree
Showing 11 changed files with 546 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .btd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ formats: [ html, pdf, man ]
images:
base: vhdl/doc
latex: btdi/latex
theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v0
theme: https://codeload.github.com/buildthedocs/sphinx.theme/tar.gz/v1
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,39 @@
[![Documentation License](https://img.shields.io/badge/doc%20license-CC--BY%204.0-green)](LICENSE.md)
[![Documentation - Read Now!](https://img.shields.io/badge/doc-read%20now%20%E2%9E%94-blueviolet)](https://vhdl.github.io/pyVHDLModel/)

# pyVHDLModel

An abstract VHDL language model written in Python.

<p align="center">
<a title="vhdl.github.io/pyVHDLModel" href="https://vhdl.github.io/pyVHDLModel"><img width="500px" src="doc/_static/banner.svg"/></a>
</p>


## Main Goals
This package provides a unified abstract language model for VHDL. Projects reading
from source files can derive own classes and implement additional logic to create
a concrete language model for their tools.

Projects consuming pre-processed VHDL data (parsed, analyzed or elaborated) can
build higher level features and services on such a model, while supporting multiple
frontends.
This package provides a unified abstract language model for VHDL.
Projects reading from source files can derive own classes and implement additional logic to create a concrete language
model for their tools.

Projects consuming pre-processed VHDL data (parsed, analyzed or elaborated) can build higher level features and services
on such a model, while supporting multiple frontends.


## Use Cases
**pyVHDLModel Generators**

### pyVHDLModel Generators

* High-level API for [GHDL's](https://github.com/ghdl/ghdl) `libghdl` offered via `pyghdl`.
* Code Document-Object-Model (Code-DOM) in [pyVHDLParser](https://github.com/Paebbels/pyVHDLParser).

**pyVHDLModel Consumers**
### pyVHDLModel Consumers

* Create graphical views of VHDL files or designs.
Possible candidates: [Symbolator](https://github.com/kevinpt/symbolator)
* Created a (re)formatted output of VHDL.


## Examples

### List all Entities with Generics and Ports

The following tiny example is based on GHDL's [`pyGHDL.dom`](https://github.com/ghdl/ghdl/tree/master/pyGHDL/dom) package implementing
Expand Down Expand Up @@ -76,10 +83,8 @@ for entity in document.Entities:
```





## Contributors

* [Patrick Lehmann](https://github.com/Paebbels) (Maintainer)
* [Unai Martinez-Corral](https://github.com/umarcor)
* [and more...](https://github.com/VHDL/pyVHDLModel/graphs/contributors)
Expand Down
6 changes: 3 additions & 3 deletions doc/Dependency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Dependency
.. |img-pyVHDLModel-lib-status| image:: https://img.shields.io/librariesio/release/pypi/pyVHDLModel
:alt: Libraries.io status for latest release
:height: 22
:target: https://libraries.io/github/Paebbels/pyVHDLModel
.. |img-pyVHDLModel-req-status| image:: https://img.shields.io/requires/github/Paebbels/pyVHDLModel
:target: https://libraries.io/github/VHDL/pyVHDLModel
.. |img-pyVHDLModel-req-status| image:: https://img.shields.io/requires/github/VHDL/pyVHDLModel
:alt: Requires.io
:height: 22
:target: https://requires.io/github/Paebbels/pyVHDLModel/requirements/?branch=master
:target: https://requires.io/github/VHDL/pyVHDLModel/requirements/?branch=master

+------------------------------------------+------------------------------------------+
| `Libraries.io <https://libraries.io/>`_ | `Requires.io <https://requires.io/>`_ |
Expand Down
Empty file removed doc/_static/.gitempty
Empty file.
209 changes: 209 additions & 0 deletions doc/_static/banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 90 additions & 0 deletions doc/_static/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 140fd19

Please sign in to comment.