Metadata-Version: 1.1
Name: hdlparse
Version: 1.0.3
Summary: HDL parser
Home-page: http://kevinpt.github.io/hdlparse
Author: Kevin Thibedeau
Author-email: kevin.thibedeau@gmail.com
License: MIT
Download-URL: http://kevinpt.github.io/hdlparse
Description: 
        ========
        Hdlparse
        ========
        
        Hdlparse is a simple package implementing a rudimentary parser for VHDL and Verilog. It is not capable of fully parsing the entire language. Rather, it is meant to extract enough key information from a source file to create generated documentation.
        
        This library is used by the `Symbolator <https://github.com/kevinpt/symbolator>`_ diagram generator.
        
        For VHDL this library can extract component, subprogram, type, subtype, and constant declarations from a package. For Verilog it can extract module declarations (both 1995 and 2001 syntax).
        
        
        Requirements
        ------------
        
        Hdlparse requires either Python 2.7 or Python 3.x and no additional libraries.
        
        The installation script depends on setuptools. The source is written in
        Python 2.7 syntax but will convert cleanly to Python 3 when the installer
        passes it through 2to3.
        
        
        Download
        --------
        
        You can access the Hdlparse Git repository from `Github
        <https://github.com/kevinpt/hdlparse>`_. You can install direct from PyPI with the "pip"
        command if you have it available.
        
        Installation
        ------------
        
        Hdlparse is a Python library. You must have Python installed first to use it. Most modern Linux distributions and OS/X have it available by default. There are a number of options available for Windows. If you don't already have a favorite, I recommend getting one of the `"full-stack" Python distros <http://www.scipy.org/install.html>`_ that are geared toward scientific computing such as Anaconda or Python(x,y).
        
        You need to have the Python setuptools installed first. If your OS has a package manager, it may be preferable to install setuptools through that tool. Otherwise you can use Pip:
        
        .. code-block:: sh
        
          > pip install setuptools
        
        The easiest way to install Hdlparse is from `PyPI <https://pypi.python.org/pypi/hdlparse>`_.
        
        .. code-block:: sh
        
          > pip install --upgrade hdlparse
        
        This will download and install the latest release, upgrading if you already have it installed. If you don't have ``pip`` you may have the ``easy_install`` command available which can be used to install ``pip`` on your system:
        
        .. code-block:: sh
        
          > easy_install pip
        
        
        You can also use ``pip`` to get the latest development code from Github:
        
        .. code-block:: sh
        
          > pip install --upgrade https://github.com/kevinpt/hdlparse/tarball/master
        
        If you manually downloaded a source package or created a clone with Git you can install with the following command run from the base Hdlparse directory:
        
        .. code-block:: sh
        
          > python setup.py install
        
        On Linux systems you may need to install with root privileges using the *sudo* command.
        
        After a successful install the Hdlparse library will be available.
        
        
        Documentation
        -------------
        
        The full documentation is available online at the `main Hdlparse site
        <http://kevinpt.github.io/hdlparse/>`_.
        
        
Keywords: HDL parser
Platform: Any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: General
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
