ipxact2sv


Nameipxact2sv JSON
Version 1.0.6 PyPI version JSON
download
home_pagehttps://github.com/paulmsv/ipxact2sv
SummaryGenerate SystemVerilog, html, rst, md, pdf, docx, C headers from an IPXACT description
upload_time2024-03-11 19:56:34
maintainer
docs_urlNone
authorpaulmsv
requires_python>=3
licenseGPL
keywords ipxact2sv systemverilog html rst md pdf ipxact
VCS
bugtrack_url
requirements docutils lxml mdutils restructuredtext-lint sphinx sphinxcontrib-wavedrom rstcloth
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ipxact2sv ipxact2rst ipxact2md ipxact2c

[![image](https://badge.fury.io/py/ipxact2sv.svg)](https://pypi.python.org/pypi/ipxact2sv/)

Утилита предназначена для генерации пригодного для синтеза SystemVerilog кода
карты регистров из IP-XACT XML описания, а также текстового описания в форматах
html, pdf, rst, md. Утилита не предназначена для генерации OVM или UVM package.

## Использование

```bash
pip install ipxact2sv

ipxact2sv --srcFile FILE --destDir DIR
ipxact2svh --srcFile FILE --destDir DIR
ipxact2rst --srcFile FILE --destDir DIR
ipxact2md --srcFile FILE --destDir DIR
ipxact2c --srcFile FILE --destDir DIR
```

## Разработка

See https://github.com/paulmMSV/ipxact2sv

## Тестирование

```bash
make
```

Если установлен ModelSim:

```bash
make compile
make sim
```

## Примечание

Для преобразования в любой текстовый формат можно использовать <http://pandoc.org/demos.html>.

## Валидация

Для формальной проверки синтаксиса XML-файла :

```bash
xmllint --noout --schema ipxact2sv/xml/component.xsd  example/input/test.xml
```

## Зависимости (обязательные)

```bash
pip install docutils lxml mdutils
```

## Зависимости (необязательные)

Не требуются для самой утилиты ipxact2sv, bно используются для генерации текстовых файлов в example/output.

```bash
sudo apt install pandoc

# для использования sphinx
sudo apt install texlive
sudo apt install texlive-lang-cyrillic
sudo apt install latexmk
```


## Для работы в режиме разработки pypi

```bash
rm -rf dist
pip3 install -e .
python3 setup.py sdist
twine upload dist/*
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/paulmsv/ipxact2sv",
    "name": "ipxact2sv",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "ipxact2sv SystemVerilog html rst md pdf IPXACT",
    "author": "paulmsv",
    "author_email": "bobkovpg@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ad/d9/1faf2d25792cc2e0a30c27f6f0ffbcea2c169e8892628c9f7c9f255948fa/ipxact2sv-1.0.6.tar.gz",
    "platform": null,
    "description": "# ipxact2sv ipxact2rst ipxact2md ipxact2c\n\n[![image](https://badge.fury.io/py/ipxact2sv.svg)](https://pypi.python.org/pypi/ipxact2sv/)\n\n\u0423\u0442\u0438\u043b\u0438\u0442\u0430 \u043f\u0440\u0435\u0434\u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0430 \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438 \u043f\u0440\u0438\u0433\u043e\u0434\u043d\u043e\u0433\u043e \u0434\u043b\u044f \u0441\u0438\u043d\u0442\u0435\u0437\u0430 SystemVerilog \u043a\u043e\u0434\u0430\n\u043a\u0430\u0440\u0442\u044b \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u043e\u0432 \u0438\u0437 IP-XACT XML \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u044f, \u0430 \u0442\u0430\u043a\u0436\u0435 \u0442\u0435\u043a\u0441\u0442\u043e\u0432\u043e\u0433\u043e \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u044f \u0432 \u0444\u043e\u0440\u043c\u0430\u0442\u0430\u0445\nhtml, pdf, rst, md. \u0423\u0442\u0438\u043b\u0438\u0442\u0430 \u043d\u0435 \u043f\u0440\u0435\u0434\u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u0430 \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438 OVM \u0438\u043b\u0438 UVM package.\n\n## \u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435\n\n```bash\npip install ipxact2sv\n\nipxact2sv --srcFile FILE --destDir DIR\nipxact2svh --srcFile FILE --destDir DIR\nipxact2rst --srcFile FILE --destDir DIR\nipxact2md --srcFile FILE --destDir DIR\nipxact2c --srcFile FILE --destDir DIR\n```\n\n## \u0420\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0430\n\nSee https://github.com/paulmMSV/ipxact2sv\n\n## \u0422\u0435\u0441\u0442\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u0435\n\n```bash\nmake\n```\n\n\u0415\u0441\u043b\u0438 \u0443\u0441\u0442\u0430\u043d\u043e\u0432\u043b\u0435\u043d ModelSim:\n\n```bash\nmake compile\nmake sim\n```\n\n## \u041f\u0440\u0438\u043c\u0435\u0447\u0430\u043d\u0438\u0435\n\n\u0414\u043b\u044f \u043f\u0440\u0435\u043e\u0431\u0440\u0430\u0437\u043e\u0432\u0430\u043d\u0438\u044f \u0432 \u043b\u044e\u0431\u043e\u0439 \u0442\u0435\u043a\u0441\u0442\u043e\u0432\u044b\u0439 \u0444\u043e\u0440\u043c\u0430\u0442 \u043c\u043e\u0436\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c <http://pandoc.org/demos.html>.\n\n## \u0412\u0430\u043b\u0438\u0434\u0430\u0446\u0438\u044f\n\n\u0414\u043b\u044f \u0444\u043e\u0440\u043c\u0430\u043b\u044c\u043d\u043e\u0439 \u043f\u0440\u043e\u0432\u0435\u0440\u043a\u0438 \u0441\u0438\u043d\u0442\u0430\u043a\u0441\u0438\u0441\u0430 XML-\u0444\u0430\u0439\u043b\u0430 :\n\n```bash\nxmllint --noout --schema ipxact2sv/xml/component.xsd  example/input/test.xml\n```\n\n## \u0417\u0430\u0432\u0438\u0441\u0438\u043c\u043e\u0441\u0442\u0438 (\u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u044c\u043d\u044b\u0435)\n\n```bash\npip install docutils lxml mdutils\n```\n\n## \u0417\u0430\u0432\u0438\u0441\u0438\u043c\u043e\u0441\u0442\u0438 (\u043d\u0435\u043e\u0431\u044f\u0437\u0430\u0442\u0435\u043b\u044c\u043d\u044b\u0435)\n\n\u041d\u0435 \u0442\u0440\u0435\u0431\u0443\u044e\u0442\u0441\u044f \u0434\u043b\u044f \u0441\u0430\u043c\u043e\u0439 \u0443\u0442\u0438\u043b\u0438\u0442\u044b ipxact2sv, b\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044e\u0442\u0441\u044f \u0434\u043b\u044f \u0433\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u0438 \u0442\u0435\u043a\u0441\u0442\u043e\u0432\u044b\u0445 \u0444\u0430\u0439\u043b\u043e\u0432 \u0432 example/output.\n\n```bash\nsudo apt install pandoc\n\n# \u0434\u043b\u044f \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u044f sphinx\nsudo apt install texlive\nsudo apt install texlive-lang-cyrillic\nsudo apt install latexmk\n```\n\n\n## \u0414\u043b\u044f \u0440\u0430\u0431\u043e\u0442\u044b \u0432 \u0440\u0435\u0436\u0438\u043c\u0435 \u0440\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0438 pypi\n\n```bash\nrm -rf dist\npip3 install -e .\npython3 setup.py sdist\ntwine upload dist/*\n```\n\n\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "Generate SystemVerilog, html, rst, md, pdf, docx, C headers from an IPXACT description",
    "version": "1.0.6",
    "project_urls": {
        "Homepage": "https://github.com/paulmsv/ipxact2sv"
    },
    "split_keywords": [
        "ipxact2sv",
        "systemverilog",
        "html",
        "rst",
        "md",
        "pdf",
        "ipxact"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "add91faf2d25792cc2e0a30c27f6f0ffbcea2c169e8892628c9f7c9f255948fa",
                "md5": "63c5b634773d07aea9fdc9fb7bc7ab78",
                "sha256": "3d26cebe22d8648fe8413fb8e1b8c8406ba7a4f80d2fc4b5e64706840a4a6e00"
            },
            "downloads": -1,
            "filename": "ipxact2sv-1.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "63c5b634773d07aea9fdc9fb7bc7ab78",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 48685,
            "upload_time": "2024-03-11T19:56:34",
            "upload_time_iso_8601": "2024-03-11T19:56:34.289992Z",
            "url": "https://files.pythonhosted.org/packages/ad/d9/1faf2d25792cc2e0a30c27f6f0ffbcea2c169e8892628c9f7c9f255948fa/ipxact2sv-1.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-11 19:56:34",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "paulmsv",
    "github_project": "ipxact2sv",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "docutils",
            "specs": []
        },
        {
            "name": "lxml",
            "specs": []
        },
        {
            "name": "mdutils",
            "specs": []
        },
        {
            "name": "restructuredtext-lint",
            "specs": []
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "sphinxcontrib-wavedrom",
            "specs": []
        },
        {
            "name": "rstcloth",
            "specs": []
        }
    ],
    "lcname": "ipxact2sv"
}
        
Elapsed time: 0.34039s