| Name | repo2md JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Python module to convert GitHub repositories to markdown files. |
| upload_time | 2025-07-22 16:23:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
repo2md
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
click
python-dotenv
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# repo2md
`repo2md` is a python module to convert GitHub repositories into Markdown files.
![Python][label-pyversion]
**Platform Supported**
![Platform][label-platform]
**Deployments**
[![pypi][label-actions-pypi]][gha_pypi]
[![Pypi][label-pypi]][pypi]
[![Pypi-format][label-pypi-format]][pypi-files]
[![Pypi-status][label-pypi-status]][pypi]
## Installation
```shell
pip install repo2md
```
## Usage
```python
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
```shell
repo2md --help
```
> _The CLI exposes fewer options than using the module directly in code._
## Coding Standards
Docstring format: [`Google`][google-docs] <br>
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```
**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
**Requirement**
```shell
python -m pip install pre-commit
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[![pypi-module][label-pypi-package]][pypi-repo]
[https://pypi.org/project/repo2md/][pypi]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[//]: # (Labels)
[3.11]: https://docs.python.org/3/whatsnew/3.11.html
[license]: https://github.com/thevickypedia/repo2md/blob/main/LICENSE
[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[pep8]: https://www.python.org/dev/peps/pep-0008/
[isort]: https://pycqa.github.io/isort/
[samples]: https://github.com/thevickypedia/repo2md/tree/main/samples
[label-actions-pypi]: https://github.com/thevickypedia/repo2md/actions/workflows/python-publish.yaml/badge.svg
[label-pypi]: https://img.shields.io/pypi/v/repo2md
[label-pypi-format]: https://img.shields.io/pypi/format/repo2md
[label-pypi-status]: https://img.shields.io/pypi/status/repo2md
[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-repo2md-blue?style=for-the-badge&logo=Python
[label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
[release-notes]: https://github.com/thevickypedia/repo2md/blob/main/release_notes.rst
[gha_pypi]: https://github.com/thevickypedia/repo2md/actions/workflows/python-publish.yml
[pypi]: https://pypi.org/project/repo2md
[pypi-files]: https://pypi.org/project/repo2md/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
Raw data
{
"_id": null,
"home_page": null,
"name": "repo2md",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "repo2md",
"author": null,
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": null,
"platform": null,
"description": "# repo2md\n\n`repo2md` is a python module to convert GitHub repositories into Markdown files.\n\n![Python][label-pyversion]\n\n**Platform Supported**\n\n![Platform][label-platform]\n\n**Deployments**\n\n[![pypi][label-actions-pypi]][gha_pypi]\n\n[![Pypi][label-pypi]][pypi]\n[![Pypi-format][label-pypi-format]][pypi-files]\n[![Pypi-status][label-pypi-status]][pypi]\n\n## Installation\n\n```shell\npip install repo2md\n```\n\n## Usage\n\n```python\nimport os\nimport dotenv\n\nimport repo2md\n\nrepo2md.IGNORE_DIRECTORIES.append(\"docs_gen\")\nrepo2md.IGNORE_LIST.append(\"docs_gen\")\n\ndotenv.load_dotenv(\".env\", override=True)\n\nrepo2md.convert_repo_to_md(\n repo_name=\"Jarvis\",\n git_owner=\"thevickypedia\",\n git_token=os.getenv(\"GIT_TOKEN\"),\n)\n```\n\n#### CLI\n\n```shell\nrepo2md --help\n```\n> _The CLI exposes fewer options than using the module directly in code._\n\n## Coding Standards\nDocstring format: [`Google`][google-docs] <br>\nStyling conventions: [`PEP 8`][pep8] and [`isort`][isort]\n\n## [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n\n**Requirement**\n```shell\npython -m pip install pre-commit\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[![pypi-module][label-pypi-package]][pypi-repo]\n\n[https://pypi.org/project/repo2md/][pypi]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[//]: # (Labels)\n\n[3.11]: https://docs.python.org/3/whatsnew/3.11.html\n[license]: https://github.com/thevickypedia/repo2md/blob/main/LICENSE\n[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[pep8]: https://www.python.org/dev/peps/pep-0008/\n[isort]: https://pycqa.github.io/isort/\n[samples]: https://github.com/thevickypedia/repo2md/tree/main/samples\n\n[label-actions-pypi]: https://github.com/thevickypedia/repo2md/actions/workflows/python-publish.yaml/badge.svg\n[label-pypi]: https://img.shields.io/pypi/v/repo2md\n[label-pypi-format]: https://img.shields.io/pypi/format/repo2md\n[label-pypi-status]: https://img.shields.io/pypi/status/repo2md\n[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-repo2md-blue?style=for-the-badge&logo=Python\n[label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue\n[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg\n[release-notes]: https://github.com/thevickypedia/repo2md/blob/main/release_notes.rst\n\n[gha_pypi]: https://github.com/thevickypedia/repo2md/actions/workflows/python-publish.yml\n\n[pypi]: https://pypi.org/project/repo2md\n[pypi-files]: https://pypi.org/project/repo2md/#files\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n",
"bugtrack_url": null,
"license": null,
"summary": "Python module to convert GitHub repositories to markdown files.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/thevickypedia/repo2md/issues",
"Homepage": "https://github.com/thevickypedia/repo2md",
"Release Notes": "https://github.com/thevickypedia/repo2md/blob/main/release_notes.rst",
"Source": "https://github.com/thevickypedia/repo2md"
},
"split_keywords": [
"repo2md"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "eab7a958afb933625a2f9ca25b218198e20a09f87571959367cc904f133e6a19",
"md5": "46edfd3a90bbc5ca0460737b1caf6693",
"sha256": "8fe8ac57eb9c159e648b3f423bfb87bf102423b6afccfdb7ee561e3eb817bff3"
},
"downloads": -1,
"filename": "repo2md-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46edfd3a90bbc5ca0460737b1caf6693",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12971,
"upload_time": "2025-07-22T16:23:24",
"upload_time_iso_8601": "2025-07-22T16:23:24.871095Z",
"url": "https://files.pythonhosted.org/packages/ea/b7/a958afb933625a2f9ca25b218198e20a09f87571959367cc904f133e6a19/repo2md-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-22 16:23:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "repo2md",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"8.*"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
"==",
"1.*"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.*"
]
]
}
],
"lcname": "repo2md"
}
