eyes3scribe 0.2.0

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

Eyes3Scribe

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 <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)

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
2. Quick & Simple Call Graphs in Python pyan
3. Build a Call graph in python including modules and functions?
4. What is a Call Graph? And How to Generate them Automatically
5. Crabviz: a call graph generator for various programming languages
6. Insane: 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:

cd eyes3scribe && git init

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

make poetry-download

3. Initialize poetry and install pre-commit hooks:

make install
make pre-commit-install

4. Run the codestyle:

make codestyle

5. Upload initial code to GitHub:

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 to ensure you have the latest dependencies.
• Set up Stale bot for automatic issue closing.

Poetry

Want to know more about Poetry? Check its documentation.

Details about Poetry

Poetry's 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 <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 standard.
• Make a commit to GitHub.
• Create a GitHub release.
• And... publish 🙂 poetry publish --build

Installation

pip install -U eyes3scribe

or install with Poetry

poetry add eyes3scribe

Then you can run

eyes3scribe --help

or with Poetry:

poetry run eyes3scribe --help

Makefile usage

Makefile contains a lot of functions for faster development.

1. Download and remove Poetry

To download and install Poetry run:

make poetry-download

To uninstall

make poetry-remove

2. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

3. Codestyle

Automatic formatting uses pyupgrade, isort and black.

make codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:

make check-codestyle

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

Update all dev libraries to the latest version using one comand

make update-dev-deps

4. Code security

make check-safety

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

make check-safety

5. Type checks

Run mypy static type checker

make mypy

6. Tests with coverage badges

Run pytest

make test

7. All linters

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

make lint

the same as:

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

8. Docker

make docker-build

which is equivalent to:

make docker-build VERSION=latest

Remove docker image with

make docker-remove

More information about docker.

9. Cleanup

Delete pycache files

make pycache-remove

Remove package build

make build-remove

Delete .DS_STORE files

make dsstore-remove

Remove .mypycache

make mypycache-remove

Or to remove all above run:

make cleanup

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use 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.

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

This project is licensed under the terms of the Apache Software License 2.0 license. See LICENSE for more details.

📃 Citation

@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

This project was generated with python-package-template