Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stablecaps/eyes3scribe
Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs
https://github.com/stablecaps/eyes3scribe
auto-documentation automation bash documentation documentation-tool html mark markdown markdown-to-html mkdocs pandoc python3 rst shell shell-script sphinx static-site-generator website-builder website-generation
Last synced: 3 days ago
JSON representation
Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs
- Host: GitHub
- URL: https://github.com/stablecaps/eyes3scribe
- Owner: stablecaps
- License: apache-2.0
- Created: 2023-10-05T00:30:42.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-04-13T23:11:11.000Z (6 months ago)
- Last Synced: 2024-04-14T13:08:42.819Z (6 months ago)
- Topics: auto-documentation, automation, bash, documentation, documentation-tool, html, mark, markdown, markdown-to-html, mkdocs, pandoc, python3, rst, shell, shell-script, sphinx, static-site-generator, website-builder, website-generation
- Language: Python
- Homepage:
- Size: 13.6 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# Eyes3Scribe
[](https://github.com/psf/black)
[](https://github.com/stablecaps/eyes3scribe/blob/master/.pre-commit-config.yaml)
[](https://github.com/stablecaps/eyes3scribe/releases)
[](https://github.com/stablecaps/eyes3scribe/blob/master/LICENSE)
[](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)
[](https://app.deepsource.com/gh/stablecaps/eyes3scribe/)
[](https://github.com/stablecaps/eyes3scribe/actions/workflows/test-python-app.yml)
[](https://github.com/stablecaps/eyes3scribe/actions/workflows/github-repo-stats.yml)
[](https://github.com/stablecaps/eyes3scribe/actions?query=workflow%3Abuild)
Automatically creates HTML documentation files for BASH/Shell source code using markdown & python mkdocs
# 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
cd
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))__
## 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 about Poetry
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
### Building and releasing your package
Building a new version of the application contains steps:
- Bump the version of your package `poetry 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.
1. Download and remove Poetry
To download and install Poetry run:
```bash
make poetry-download
```
To uninstall
```bash
make poetry-remove
```
2. Install all dependencies and pre-commit hooks
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
3. Codestyle
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
```
4. Code security
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
5. Type checks
Run `mypy` static type checker
```bash
make mypy
```
6. Tests with coverage badges
Run `pytest`
```bash
make test
```
7. All linters
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
```
8. Docker
```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).
9. Cleanup
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
```
## 📈 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
[](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 [](https://github.com/stablecaps/stablecaps-pycookiecutter-template)
This project was generated with [`python-package-template`](https://github.com/stablecaps/stablecaps-pycookiecutter-template)