eyes3scribe


Nameeyes3scribe JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/stablecaps/eyes3scribe
SummaryAutomatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs
upload_time2024-03-01 20:31:41
maintainer
docs_urlNone
authorStablecaps
requires_python>=3.9,<4.0
licenseApache Software License 2.0
keywords shell html bash markdown documentation automation pandoc sphinx documentation-tool mkdocs python3 website-builder website-generation shell-script markdown-to-html rst auto-documentation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Eyes3Scribe

<div align="center">


![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eyes3scribe)
[![Style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/stablecaps/eyes3scribe/blob/master/.pre-commit-config.yaml)
[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/stablecaps/eyes3scribe/releases)
[![License](https://img.shields.io/github/license/stablecaps/eyes3scribe)](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE)
[![DeepSource](https://app.deepsource.com/gh/stablecaps/eyes3scribe.svg/?label=active+issues&show_trend=true&token=JveipNb_ClaKjk0YBBKrG-32)](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)
[![DeepSource](https://app.deepsource.com/gh/stablecaps/eyes3scribe.svg/?label=resolved+issues&show_trend=true&token=JveipNb_ClaKjk0YBBKrG-32)](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)
![Coverage Report](assets/images/coverage.svg)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/stablecaps/eyes3scribe/total)
[![Test eyes3scribe](https://github.com/stablecaps/eyes3scribe/actions/workflows/test-python-app.yml/badge.svg)](https://github.com/stablecaps/eyes3scribe/actions/workflows/test-python-app.yml)
[![repo-stats](https://github.com/stablecaps/eyes3scribe/actions/workflows/github-repo-stats.yml/badge.svg)](https://github.com/stablecaps/eyes3scribe/actions/workflows/github-repo-stats.yml)
![Stable Version](https://img.shields.io/pypi/v/eyes3scribe?label=stable)
[![Build status](https://github.com/stablecaps/eyes3scribe/workflows/build/badge.svg?branch=master&event=push)](https://github.com/stablecaps/eyes3scribe/actions?query=workflow%3Abuild)


Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs

</div>

# This is still a WIP!!!

## Overview
This project is a Python application that uses pip for package management. The main entry point for the application is gen_mkdocs_site.py.

**Features:**

0. Uses mkdocs to create websites with any mkdocs theme
1. Auto-generates BASH shell script documentation from src code that are marked with composure annotations.
2. Create alias tables from shell code
3. Preserves handwritten documentation (TBD)
4. Converts existing RST docs --> Markdown docs (TBD)
5. Auto-generates Python documentation from source code (TBD)


### Prerequisites
* Python 3.x
* poetry/pip

## Installation

```
git clone <repository_url>
cd <project_directory>
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```

## Usage
```
# Run program to create mkdocs documentation site and serve it locally.
python gen_mkdocs_site.py --site-confname config/bash_it_site.yaml ---build-serve

# Show help
python gen_mkdocs_site.py --help
```
### Program options
1. `--site_confname` (str): The name of the site configuration.
2. `--build_serve` (bool): Whether to build and serve the local MkDocs site.
3. `--check_singlefile` (str): The path of a single shell source file to debug.
4. `--debug` (bool, optional): If True, debug information will be printed. Defaults to False.



## Program structure

**Auto-Documatix Callgraph:**
__(made with [PyDeps](https://github.com/thebjorn/pydeps?tab=readme-ov-file#usage))__
![PyDeps](images/launcher.svg)

## Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

## License
This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.


## Not so Random info links

### Python call graphs
1. [Generating and using a Callgraph, in Python](https://cerfacs.fr/coop/pycallgraph)
2. [Quick & Simple Call Graphs in Python](https://medium.com/parkbee/quick-simple-call-graphs-in-python-eaa583d0e1b2)
    [pyan](https://github.com/Technologicat/pyan)
3. [Build a Call graph in python including modules and functions?](https://stackoverflow.com/questions/13963321/build-a-call-graph-in-python-including-modules-and-functions)
4. [What is a Call Graph? And How to Generate them Automatically](https://www.freecodecamp.org/news/how-to-automate-call-graph-creation/)
5. [Crabviz: a call graph generator for various programming languages](https://www.reddit.com/r/rust/comments/142is0h/crabviz_a_call_graph_generator_for_various/)
6. [**Insane**: Callgraphs with Ghidra, Pyhidra, and Jpype](https://clearbluejar.github.io/posts/callgraphs-with-ghidra-pyhidra-and-jpype/)


### Dependency analysis v2

1. https://github.com/glato/emerge
2. https://github.com/thebjorn/pydeps
3. https://www.python.org/success-stories/building-a-dependency-graph-of-our-python-codebase/


## Very first steps

### Initialize your code

1. Initialize `git` inside your repo:

```bash
cd eyes3scribe && git init
```

2. If you don't have `Poetry` installed run:

```bash
make poetry-download
```

3. Initialize poetry and install `pre-commit` hooks:

```bash
make install
make pre-commit-install
```

4. Run the codestyle:

```bash
make codestyle
```

5. Upload initial code to GitHub:

```bash
git add .
git commit -m ":tada: Initial commit"
git branch -M main
git remote add origin https://github.com/stablecaps/eyes3scribe.git
git push -u origin main
```

### Set up bots

- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.
- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.

### Poetry

Want to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).

<details>
<summary>Details about Poetry</summary>
<p>

Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:

- `poetry add numpy@latest`
- `poetry run pytest`
- `poetry publish --build`

etc
</p>
</details>

### Building and releasing your package

Building a new version of the application contains steps:

- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.
- Make a commit to `GitHub`.
- Create a `GitHub release`.
- And... publish πŸ™‚ `poetry publish --build`



## Installation

```bash
pip install -U eyes3scribe
```

or install with `Poetry`

```bash
poetry add eyes3scribe
```

Then you can run

```bash
eyes3scribe --help
```

or with `Poetry`:

```bash
poetry run eyes3scribe --help
```

### Makefile usage

[`Makefile`](https://github.com/stablecaps/eyes3scribe/blob/master/Makefile) contains a lot of functions for faster development.

<details>
<summary>1. Download and remove Poetry</summary>
<p>

To download and install Poetry run:

```bash
make poetry-download
```

To uninstall

```bash
make poetry-remove
```

</p>
</details>

<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>

Install requirements:

```bash
make install
```

Pre-commit hooks coulb be installed after `git init` via

```bash
make pre-commit-install
```

</p>
</details>

<details>
<summary>3. Codestyle</summary>
<p>

Automatic formatting uses `pyupgrade`, `isort` and `black`.

```bash
make codestyle

# or use synonym
make formatting
```

Codestyle checks only, without rewriting files:

```bash
make check-codestyle
```

> Note: `check-codestyle` uses `isort`, `black` and `darglint` library

Update all dev libraries to the latest version using one comand

```bash
make update-dev-deps
```

</p>
</details>

<details>
<summary>4. Code security</summary>
<p>

```bash
make check-safety
```

This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.

```bash
make check-safety
```

</p>
</details>

<details>
<summary>5. Type checks</summary>
<p>

Run `mypy` static type checker

```bash
make mypy
```

</p>
</details>

<details>
<summary>6. Tests with coverage badges</summary>
<p>

Run `pytest`

```bash
make test
```

</p>
</details>

<details>
<summary>7. All linters</summary>
<p>

Of course there is a command to ~~rule~~ run all linters in one:

```bash
make lint
```

the same as:

```bash
make test && make check-codestyle && make mypy && make check-safety
```

</p>
</details>

<details>
<summary>8. Docker</summary>
<p>

```bash
make docker-build
```

which is equivalent to:

```bash
make docker-build VERSION=latest
```

Remove docker image with

```bash
make docker-remove
```

More information [about docker](https://github.com/stablecaps/eyes3scribe/tree/master/docker).

</p>
</details>

<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files

```bash
make pycache-remove
```

Remove package build

```bash
make build-remove
```

Delete .DS_STORE files

```bash
make dsstore-remove
```

Remove .mypycache

```bash
make mypycache-remove
```

Or to remove all above run:

```bash
make cleanup
```

</p>
</details>

## πŸ“ˆ Releases

You can see the list of available releases on the [GitHub Releases](https://github.com/stablecaps/eyes3scribe/releases) page.

We follow [Semantic Versions](https://semver.org/) specification.

We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

### List of labels and corresponding titles

|               **Label**               |  **Title in Releases**  |
| :-----------------------------------: | :---------------------: |
|       `enhancement`, `feature`        |       πŸš€ Features       |
| `bug`, `refactoring`, `bugfix`, `fix` | πŸ”§ Fixes & Refactoring  |
|       `build`, `ci`, `testing`        | πŸ“¦ Build System & CI/CD |
|              `breaking`               |   πŸ’₯ Breaking Changes   |
|            `documentation`            |    πŸ“ Documentation     |
|            `dependencies`             | ⬆️ Dependencies updates |

You can update it in [`release-drafter.yml`](https://github.com/stablecaps/eyes3scribe/blob/master/.github/release-drafter.yml).

GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

## πŸ›‘ License

[![License](https://img.shields.io/github/license/stablecaps/eyes3scribe)](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE)

This project is licensed under the terms of the `Apache Software License 2.0` license. See [LICENSE](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE) for more details.

## πŸ“ƒ Citation

```bibtex
@misc{eyes3scribe,
  author = {Stablecaps},
  title = {Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/stablecaps/eyes3scribe}}
}
```

## Credits [![πŸš€ Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/stablecaps/stablecaps-pycookiecutter-template)

This project was generated with [`python-package-template`](https://github.com/stablecaps/stablecaps-pycookiecutter-template)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stablecaps/eyes3scribe",
    "name": "eyes3scribe",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "shell,html,bash,markdown,documentation,automation,pandoc,sphinx,documentation-tool,mkdocs,python3,website-builder,website-generation,shell-script,markdown-to-html,rst,auto-documentation",
    "author": "Stablecaps",
    "author_email": "14529342+darkpandarts@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/06/20/8cc5fbf0a981e118548312779099c9c9b667f99d4c42daf05c511e23e894/eyes3scribe-0.2.0.tar.gz",
    "platform": null,
    "description": "# Eyes3Scribe\n\n<div align=\"center\">\n\n\n![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eyes3scribe)\n[![Style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/stablecaps/eyes3scribe/blob/master/.pre-commit-config.yaml)\n[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/stablecaps/eyes3scribe/releases)\n[![License](https://img.shields.io/github/license/stablecaps/eyes3scribe)](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE)\n[![DeepSource](https://app.deepsource.com/gh/stablecaps/eyes3scribe.svg/?label=active+issues&show_trend=true&token=JveipNb_ClaKjk0YBBKrG-32)](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)\n[![DeepSource](https://app.deepsource.com/gh/stablecaps/eyes3scribe.svg/?label=resolved+issues&show_trend=true&token=JveipNb_ClaKjk0YBBKrG-32)](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)\n![Coverage Report](assets/images/coverage.svg)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/stablecaps/eyes3scribe/total)\n[![Test eyes3scribe](https://github.com/stablecaps/eyes3scribe/actions/workflows/test-python-app.yml/badge.svg)](https://github.com/stablecaps/eyes3scribe/actions/workflows/test-python-app.yml)\n[![repo-stats](https://github.com/stablecaps/eyes3scribe/actions/workflows/github-repo-stats.yml/badge.svg)](https://github.com/stablecaps/eyes3scribe/actions/workflows/github-repo-stats.yml)\n![Stable Version](https://img.shields.io/pypi/v/eyes3scribe?label=stable)\n[![Build status](https://github.com/stablecaps/eyes3scribe/workflows/build/badge.svg?branch=master&event=push)](https://github.com/stablecaps/eyes3scribe/actions?query=workflow%3Abuild)\n\n\nAutomatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs\n\n</div>\n\n# This is still a WIP!!!\n\n## Overview\nThis project is a Python application that uses pip for package management. The main entry point for the application is gen_mkdocs_site.py.\n\n**Features:**\n\n0. Uses mkdocs to create websites with any mkdocs theme\n1. Auto-generates BASH shell script documentation from src code that are marked with composure annotations.\n2. Create alias tables from shell code\n3. Preserves handwritten documentation (TBD)\n4. Converts existing RST docs --> Markdown docs (TBD)\n5. Auto-generates Python documentation from source code (TBD)\n\n\n### Prerequisites\n* Python 3.x\n* poetry/pip\n\n## Installation\n\n```\ngit clone <repository_url>\ncd <project_directory>\npython -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n```\n\n## Usage\n```\n# Run program to create mkdocs documentation site and serve it locally.\npython gen_mkdocs_site.py --site-confname config/bash_it_site.yaml ---build-serve\n\n# Show help\npython gen_mkdocs_site.py --help\n```\n### Program options\n1. `--site_confname` (str): The name of the site configuration.\n2. `--build_serve` (bool): Whether to build and serve the local MkDocs site.\n3. `--check_singlefile` (str): The path of a single shell source file to debug.\n4. `--debug` (bool, optional): If True, debug information will be printed. Defaults to False.\n\n\n\n## Program structure\n\n**Auto-Documatix Callgraph:**\n__(made with [PyDeps](https://github.com/thebjorn/pydeps?tab=readme-ov-file#usage))__\n![PyDeps](images/launcher.svg)\n\n## Contributing\nPlease read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.\n\n## License\nThis project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.\n\n\n## Not so Random info links\n\n### Python call graphs\n1. [Generating and using a Callgraph, in Python](https://cerfacs.fr/coop/pycallgraph)\n2. [Quick & Simple Call Graphs in Python](https://medium.com/parkbee/quick-simple-call-graphs-in-python-eaa583d0e1b2)\n    [pyan](https://github.com/Technologicat/pyan)\n3. [Build a Call graph in python including modules and functions?](https://stackoverflow.com/questions/13963321/build-a-call-graph-in-python-including-modules-and-functions)\n4. [What is a Call Graph? And How to Generate them Automatically](https://www.freecodecamp.org/news/how-to-automate-call-graph-creation/)\n5. [Crabviz: a call graph generator for various programming languages](https://www.reddit.com/r/rust/comments/142is0h/crabviz_a_call_graph_generator_for_various/)\n6. [**Insane**: Callgraphs with Ghidra, Pyhidra, and Jpype](https://clearbluejar.github.io/posts/callgraphs-with-ghidra-pyhidra-and-jpype/)\n\n\n### Dependency analysis v2\n\n1. https://github.com/glato/emerge\n2. https://github.com/thebjorn/pydeps\n3. https://www.python.org/success-stories/building-a-dependency-graph-of-our-python-codebase/\n\n\n## Very first steps\n\n### Initialize your code\n\n1. Initialize `git` inside your repo:\n\n```bash\ncd eyes3scribe && git init\n```\n\n2. If you don't have `Poetry` installed run:\n\n```bash\nmake poetry-download\n```\n\n3. Initialize poetry and install `pre-commit` hooks:\n\n```bash\nmake install\nmake pre-commit-install\n```\n\n4. Run the codestyle:\n\n```bash\nmake codestyle\n```\n\n5. Upload initial code to GitHub:\n\n```bash\ngit add .\ngit commit -m \":tada: Initial commit\"\ngit branch -M main\ngit remote add origin https://github.com/stablecaps/eyes3scribe.git\ngit push -u origin main\n```\n\n### Set up bots\n\n- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.\n- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.\n\n### Poetry\n\nWant to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).\n\n<details>\n<summary>Details about Poetry</summary>\n<p>\n\nPoetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:\n\n- `poetry add numpy@latest`\n- `poetry run pytest`\n- `poetry publish --build`\n\netc\n</p>\n</details>\n\n### Building and releasing your package\n\nBuilding a new version of the application contains steps:\n\n- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.\n- Make a commit to `GitHub`.\n- Create a `GitHub release`.\n- And... publish \ud83d\ude42 `poetry publish --build`\n\n\n\n## Installation\n\n```bash\npip install -U eyes3scribe\n```\n\nor install with `Poetry`\n\n```bash\npoetry add eyes3scribe\n```\n\nThen you can run\n\n```bash\neyes3scribe --help\n```\n\nor with `Poetry`:\n\n```bash\npoetry run eyes3scribe --help\n```\n\n### Makefile usage\n\n[`Makefile`](https://github.com/stablecaps/eyes3scribe/blob/master/Makefile) contains a lot of functions for faster development.\n\n<details>\n<summary>1. Download and remove Poetry</summary>\n<p>\n\nTo download and install Poetry run:\n\n```bash\nmake poetry-download\n```\n\nTo uninstall\n\n```bash\nmake poetry-remove\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>3. Codestyle</summary>\n<p>\n\nAutomatic formatting uses `pyupgrade`, `isort` and `black`.\n\n```bash\nmake codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `isort`, `black` and `darglint` library\n\nUpdate all dev libraries to the latest version using one comand\n\n```bash\nmake update-dev-deps\n```\n\n</p>\n</details>\n\n<details>\n<summary>4. Code security</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>5. Type checks</summary>\n<p>\n\nRun `mypy` static type checker\n\n```bash\nmake mypy\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>7. All linters</summary>\n<p>\n\nOf course there is a command to ~~rule~~ run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test && make check-codestyle && make mypy && make check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>8. Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/stablecaps/eyes3scribe/tree/master/docker).\n\n</p>\n</details>\n\n<details>\n<summary>9. Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83d\udcc8 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/stablecaps/eyes3scribe/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you\u2019re ready. With the categories option, you can categorize pull requests in release notes using labels.\n\n### List of labels and corresponding titles\n\n|               **Label**               |  **Title in Releases**  |\n| :-----------------------------------: | :---------------------: |\n|       `enhancement`, `feature`        |       \ud83d\ude80 Features       |\n| `bug`, `refactoring`, `bugfix`, `fix` | \ud83d\udd27 Fixes & Refactoring  |\n|       `build`, `ci`, `testing`        | \ud83d\udce6 Build System & CI/CD |\n|              `breaking`               |   \ud83d\udca5 Breaking Changes   |\n|            `documentation`            |    \ud83d\udcdd Documentation     |\n|            `dependencies`             | \u2b06\ufe0f Dependencies updates |\n\nYou can update it in [`release-drafter.yml`](https://github.com/stablecaps/eyes3scribe/blob/master/.github/release-drafter.yml).\n\nGitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.\n\n## \ud83d\udee1 License\n\n[![License](https://img.shields.io/github/license/stablecaps/eyes3scribe)](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE)\n\nThis project is licensed under the terms of the `Apache Software License 2.0` license. See [LICENSE](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE) for more details.\n\n## \ud83d\udcc3 Citation\n\n```bibtex\n@misc{eyes3scribe,\n  author = {Stablecaps},\n  title = {Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs},\n  year = {2024},\n  publisher = {GitHub},\n  journal = {GitHub repository},\n  howpublished = {\\url{https://github.com/stablecaps/eyes3scribe}}\n}\n```\n\n## Credits [![\ud83d\ude80 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/stablecaps/stablecaps-pycookiecutter-template)\n\nThis project was generated with [`python-package-template`](https://github.com/stablecaps/stablecaps-pycookiecutter-template)\n\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs",
    "version": "0.2.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/stablecaps/eyes3scribe/issues",
        "Homepage": "https://github.com/stablecaps/eyes3scribe",
        "Repository": "https://github.com/stablecaps/eyes3scribe"
    },
    "split_keywords": [
        "shell",
        "html",
        "bash",
        "markdown",
        "documentation",
        "automation",
        "pandoc",
        "sphinx",
        "documentation-tool",
        "mkdocs",
        "python3",
        "website-builder",
        "website-generation",
        "shell-script",
        "markdown-to-html",
        "rst",
        "auto-documentation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5cce4e0c55d67f26ab14a9fc282c09f98fa337f4306d124e4b1d50ffb43b7526",
                "md5": "6107263054cd592e7da749d0f65834e5",
                "sha256": "d5195ebc62ea935ae66355cdf5ad790099339fac1fffac45c88c3436d1193ffa"
            },
            "downloads": -1,
            "filename": "eyes3scribe-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6107263054cd592e7da749d0f65834e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 57670,
            "upload_time": "2024-03-01T20:31:39",
            "upload_time_iso_8601": "2024-03-01T20:31:39.677431Z",
            "url": "https://files.pythonhosted.org/packages/5c/ce/4e0c55d67f26ab14a9fc282c09f98fa337f4306d124e4b1d50ffb43b7526/eyes3scribe-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06208cc5fbf0a981e118548312779099c9c9b667f99d4c42daf05c511e23e894",
                "md5": "e7b394473a4e8c439613b5326bb16a82",
                "sha256": "5014e5541d3edb5ba4ba886b20436cc5690782f4b9ceb958199ad814fa8d2cf6"
            },
            "downloads": -1,
            "filename": "eyes3scribe-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e7b394473a4e8c439613b5326bb16a82",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 48039,
            "upload_time": "2024-03-01T20:31:41",
            "upload_time_iso_8601": "2024-03-01T20:31:41.432738Z",
            "url": "https://files.pythonhosted.org/packages/06/20/8cc5fbf0a981e118548312779099c9c9b667f99d4c42daf05c511e23e894/eyes3scribe-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-01 20:31:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stablecaps",
    "github_project": "eyes3scribe",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "eyes3scribe"
}
        
Elapsed time: 0.23726s