Python module to convert GitHub repositories to markdown files.
Project description
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"),
)
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 sphinx==5.1.1 pre-commit recommonmark
Usage
pre-commit run --all-files
Pypi Package
https://pypi.org/project/repo2md/
License & copyright
© Vignesh Rao
Licensed under the MIT License
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
repo2md-0.0.1a2-py3-none-any.whl
(10.7 kB
view details)
File details
Details for the file repo2md-0.0.1a2-py3-none-any.whl.
File metadata
- Download URL: repo2md-0.0.1a2-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e60a8df1e80a3d1e66f66102d73365275717108201a4f8475412d3a6d19c52a1
|
|
| MD5 |
6ffda230a2560f1c39d403c38ac98dcd
|
|
| BLAKE2b-256 |
6254bc2c63d8fb0c19d51c987bb2af4ef76179a7dc664d428ccb64407f8dead8
|
