repo2md

repo2md is a python module to convert GitHub repositories into Markdown files.

Platform Supported

Deployments

Installation

pip install repo2md

Usage

import os
import dotenv

import repo2md

repo2md.IGNORE_DIRECTORIES.append("docs_gen")
repo2md.IGNORE_LIST.append("docs_gen")

dotenv.load_dotenv(".env", override=True)

repo2md.convert_repo_to_md(
    repo_name="Jarvis",
    git_owner="thevickypedia",
    git_token=os.getenv("GIT_TOKEN"),
)

CLI

repo2md --help

The CLI exposes fewer options than using the module directly in code.

Coding Standards

Docstring format: Google
Styling conventions: PEP 8 and isort

Release Notes

Requirement

python -m pip install gitverse

Usage

gitverse-release reverse -f release_notes.rst -t 'Release Notes'

Linting

Requirement

python -m pip install pre-commit

Usage

pre-commit run --all-files

Pypi Package

https://pypi.org/project/repo2md/

License & copyright

© Vignesh Rao

Licensed under the MIT License