# HWDOCER
The [HardWare DOCumentation buildER][home_link] is a utility that help generating graphical documentations using [drawio][drawio_link] and [wireviz][wireviz_link]
## Install
### Stable version
_Stable_ package are release on [pypi.org][pypi_link] and are installable simply via pip:
```bash
pip install hwdocer
```
You can also clone the specific tags from the [repo][repo_link]
### Development version
_Development version_ are only available on the [repo][repo_link], the suggested process is to add a **git submodule** to your project:
1. Add the submodule
simply open a **terminal** in the host repo and execute this:
```bash
git submodule add https://gitlab.com/real-ee/public/hwdocer.git dep/hwdocer
```
2. Venv install
Then you need to [install](https://laurencedv.org/computing/python) the venv, by having [poetry][poetry_link] and [pyenv][pyenv_link].
Open a **terminal** then execute this:
```bash
poetry install
```
## Usage
### Direct call
If you installed the stable version (via [pypi](#stable-version)) you can call it directly like this:
```bash
hwdocer -vv -i "./" -o "./_build"
```
### Python module call
When installed as a python module, you can invoke it
```bash
poetry run python -m hwdocer -vvvv -i "./doc" -o "./doc/build"
```
> NOTE: Currently all `*.yml` file in the _input search_ will match for **harness** drawing and all `*.drawio` files will match for **diagram** drawing
### Adding source to be built
This tool uses [drawio](#drawio) local software and [wireviz](#wireviz) defined file, use them to creat some source file which you pass as _input_ (**-i** argument) to hwdocer.
#### Drawio
To create diagram and drawing that will be then automatically drawn by this tool, you need to install [drawio][drawio_link] local executable by downloading the installer for your OS (only linux tested)
#### Wireviz
To create wire harness, install [wireviz][wireviz_link], which is a project based on [graphviz][graphviz_link] but aimed to specifically draw wire harnesses.
## Contrib
See the [contribution guideline][contrib_file]
## Changelog
See the [release][release_file] file and [roadmap file][roadmap_file]
## License
This software is released under [GPL3][license_file]
<!-- links -->
[home_link]: https://gitlab.com/realee-laurencedv/hwdocbuilder
[poetry_link]: https://python-poetry.org/docs/
[pyenv_link]: https://github.com/pyenv/pyenv
[drawio_link]: https://github.com/jgraph/drawio-desktop/releases/
[wireviz_link]: https://github.com/wireviz/WireViz
[graphviz_link]: https://graphviz.org/
[pypi_link]: https://pypi.org/project/hwdocer/
[repo_link]: https://gitlab.com/realee-laurencedv/hwdocbuilder
<!-- files -->
[release_file]: doc/release.md
[roadmap_file]: doc/roadmap.md
[contrib_file]: doc/contrib.md
[license_file]: license
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/real-ee/public/hwdocer",
"name": "hwdocer",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "drawio, wireviz, toolchain, automation, documentation",
"author": "Laurence DV",
"author_email": "laurencedv@realee.tech",
"download_url": "https://files.pythonhosted.org/packages/85/11/3b60d013bf4cf666442ea46ddff76d62e078980b940efa59ea600032916f/hwdocer-0.2.2.tar.gz",
"platform": null,
"description": "# HWDOCER\n\nThe [HardWare DOCumentation buildER][home_link] is a utility that help generating graphical documentations using [drawio][drawio_link] and [wireviz][wireviz_link]\n\n## Install\n\n### Stable version\n\n_Stable_ package are release on [pypi.org][pypi_link] and are installable simply via pip:\n\n```bash\npip install hwdocer\n```\n\nYou can also clone the specific tags from the [repo][repo_link]\n\n### Development version\n\n_Development version_ are only available on the [repo][repo_link], the suggested process is to add a **git submodule** to your project:\n\n1. Add the submodule \n simply open a **terminal** in the host repo and execute this:\n\n ```bash\n git submodule add https://gitlab.com/real-ee/public/hwdocer.git dep/hwdocer\n ```\n\n2. Venv install\n Then you need to [install](https://laurencedv.org/computing/python) the venv, by having [poetry][poetry_link] and [pyenv][pyenv_link]. \n Open a **terminal** then execute this:\n\n ```bash\n poetry install\n ```\n\n## Usage\n\n### Direct call\n\nIf you installed the stable version (via [pypi](#stable-version)) you can call it directly like this:\n\n```bash\nhwdocer -vv -i \"./\" -o \"./_build\"\n```\n\n### Python module call\n\nWhen installed as a python module, you can invoke it\n\n```bash\npoetry run python -m hwdocer -vvvv -i \"./doc\" -o \"./doc/build\"\n```\n\n> NOTE: Currently all `*.yml` file in the _input search_ will match for **harness** drawing and all `*.drawio` files will match for **diagram** drawing\n\n### Adding source to be built\n\nThis tool uses [drawio](#drawio) local software and [wireviz](#wireviz) defined file, use them to creat some source file which you pass as _input_ (**-i** argument) to hwdocer.\n\n#### Drawio\n\nTo create diagram and drawing that will be then automatically drawn by this tool, you need to install [drawio][drawio_link] local executable by downloading the installer for your OS (only linux tested)\n\n#### Wireviz\n\nTo create wire harness, install [wireviz][wireviz_link], which is a project based on [graphviz][graphviz_link] but aimed to specifically draw wire harnesses.\n\n## Contrib\n\nSee the [contribution guideline][contrib_file]\n\n## Changelog\n\nSee the [release][release_file] file and [roadmap file][roadmap_file]\n\n## License\n\nThis software is released under [GPL3][license_file]\n\n<!-- links -->\n\n[home_link]: https://gitlab.com/realee-laurencedv/hwdocbuilder\n[poetry_link]: https://python-poetry.org/docs/\n[pyenv_link]: https://github.com/pyenv/pyenv\n[drawio_link]: https://github.com/jgraph/drawio-desktop/releases/\n[wireviz_link]: https://github.com/wireviz/WireViz\n[graphviz_link]: https://graphviz.org/\n[pypi_link]: https://pypi.org/project/hwdocer/\n[repo_link]: https://gitlab.com/realee-laurencedv/hwdocbuilder\n\n<!-- files -->\n\n[release_file]: doc/release.md\n[roadmap_file]: doc/roadmap.md\n[contrib_file]: doc/contrib.md\n[license_file]: license\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Wireviz, drawio and other documentation build tool",
"version": "0.2.2",
"project_urls": {
"Changelog": "https://gitlab.com/real-ee/public/hwdocer/-/blob/master/doc/release.md",
"Contribution": "https://gitlab.com/real-ee/public/hwdocer/-/blob/master/doc/contrib.md?ref_type=heads",
"Documentation": "https://gitlab.com/real-ee/public/hwdocer/-/tree/master/doc",
"Homepage": "https://gitlab.com/real-ee/public/hwdocer",
"Issue": "https://gitlab.com/real-ee/public/hwdocer/-/issues",
"Repository": "https://gitlab.com/real-ee/public/hwdocer",
"Roadmap": "https://gitlab.com/real-ee/public/hwdocer/-/blob/master/doc/roadmap.md"
},
"split_keywords": [
"drawio",
" wireviz",
" toolchain",
" automation",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6576b8bfc7135c4cf88c2b7ebfa31cf233c20e2383a5b3d691dc4ab91fc956dd",
"md5": "878f9f8cc45a8f9a98d27e7757d3f447",
"sha256": "78153d71f83b89f513adc027edbf4ee2b296f1b14d5553639f6e990dfd34406e"
},
"downloads": -1,
"filename": "hwdocer-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "878f9f8cc45a8f9a98d27e7757d3f447",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 10310,
"upload_time": "2024-04-09T22:14:50",
"upload_time_iso_8601": "2024-04-09T22:14:50.195657Z",
"url": "https://files.pythonhosted.org/packages/65/76/b8bfc7135c4cf88c2b7ebfa31cf233c20e2383a5b3d691dc4ab91fc956dd/hwdocer-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85113b60d013bf4cf666442ea46ddff76d62e078980b940efa59ea600032916f",
"md5": "151259d432e456fbc36431a6acc617f5",
"sha256": "75f2c14cb2ac18c52c333ff7d24526b991e9a3d84521a8de65573d4fefaafa80"
},
"downloads": -1,
"filename": "hwdocer-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "151259d432e456fbc36431a6acc617f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 10616,
"upload_time": "2024-04-09T22:14:51",
"upload_time_iso_8601": "2024-04-09T22:14:51.372197Z",
"url": "https://files.pythonhosted.org/packages/85/11/3b60d013bf4cf666442ea46ddff76d62e078980b940efa59ea600032916f/hwdocer-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 22:14:51",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "real-ee",
"gitlab_project": "public",
"lcname": "hwdocer"
}
JSON