# git2doc 📚
A powerful Python library for converting git repositories into documents. git2doc allows you to extract and analyze code from GitHub repositories, making it easier to understand and work with large codebases.
## Why git2doc? 🚀
Working with large repositories can be overwhelming, especially when trying to understand the structure and content of the code. git2doc simplifies this process by converting repositories into documents, allowing you to easily search, analyze, and understand the codebase.
## Table of Contents 📖
- [Installation](#installation)
- [Usage](#usage)
- [Fetching Repositories](#fetching-repositories)
- [Loading Repository Data](#loading-repository-data)
- [Writing Data to Parquet Files](#writing-data-to-parquet-files)
- [Badges](#badges)
- [Contributing](#contributing)
- [License](#license)
## Installation 💻
```bash
pip install git2doc
```
## Usage 🛠️
### Fetching Repositories
```python
from git2doc import get_repos_orchestrator
repos = get_repos_orchestrator(
n_repos=10,
last_n_days=30,
language="Python"
)
```
### Loading Repository Data
```python
from git2doc import pull_code_from_repo
repo_data = pull_code_from_repo(
repo="https://github.com/voynow/git2doc",
branch="main"
)
```
### Writing Data to Parquet Files
```python
from git2doc import pipeline_fetch_and_load
pipeline_fetch_and_load(
n_repos=1000,
last_n_days=365,
language="Python",
write_batch_size=100,
delete=True,
)
```
## Badges 🏅
[](https://badge.fury.io/py/git2doc)
[](https://github.com/voynow/git2doc/stargazers)
[](https://github.com/voynow/git2doc/network)
[](https://github.com/voynow/git2doc/issues)
## Contributing 🤝
Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.
## License 📄
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/voynow/git2doc",
"name": "git2doc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jamie Voynow",
"author_email": "voynow99@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/d9/815d50cc4f5e4518332438e926373529a45cbba01f8b1eef9a2a80719bcb/git2doc-0.2.3.tar.gz",
"platform": null,
"description": "# git2doc \ud83d\udcda\r\n\r\nA powerful Python library for converting git repositories into documents. git2doc allows you to extract and analyze code from GitHub repositories, making it easier to understand and work with large codebases.\r\n\r\n## Why git2doc? \ud83d\ude80\r\n\r\nWorking with large repositories can be overwhelming, especially when trying to understand the structure and content of the code. git2doc simplifies this process by converting repositories into documents, allowing you to easily search, analyze, and understand the codebase.\r\n\r\n## Table of Contents \ud83d\udcd6\r\n\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n - [Fetching Repositories](#fetching-repositories)\r\n - [Loading Repository Data](#loading-repository-data)\r\n - [Writing Data to Parquet Files](#writing-data-to-parquet-files)\r\n- [Badges](#badges)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n## Installation \ud83d\udcbb\r\n\r\n```bash\r\npip install git2doc\r\n```\r\n\r\n## Usage \ud83d\udee0\ufe0f\r\n\r\n### Fetching Repositories\r\n\r\n```python\r\nfrom git2doc import get_repos_orchestrator\r\n\r\nrepos = get_repos_orchestrator(\r\n n_repos=10,\r\n last_n_days=30,\r\n language=\"Python\"\r\n)\r\n```\r\n\r\n### Loading Repository Data\r\n\r\n```python\r\nfrom git2doc import pull_code_from_repo\r\n\r\nrepo_data = pull_code_from_repo(\r\n repo=\"https://github.com/voynow/git2doc\",\r\n branch=\"main\"\r\n)\r\n```\r\n\r\n### Writing Data to Parquet Files\r\n\r\n```python\r\nfrom git2doc import pipeline_fetch_and_load\r\n\r\npipeline_fetch_and_load(\r\n n_repos=1000,\r\n last_n_days=365,\r\n language=\"Python\",\r\n write_batch_size=100,\r\n delete=True,\r\n)\r\n```\r\n\r\n## Badges \ud83c\udfc5\r\n\r\n[](https://badge.fury.io/py/git2doc)\r\n[](https://github.com/voynow/git2doc/stargazers)\r\n[](https://github.com/voynow/git2doc/network)\r\n[](https://github.com/voynow/git2doc/issues)\r\n\r\n## Contributing \ud83e\udd1d\r\n\r\nContributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.\r\n\r\n## License \ud83d\udcc4\r\n\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A tool for converting git repositories into documents",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/voynow/git2doc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5dc4571065865d7db022c9e22fca92c6c9ca77d0b5d0a6cf0605b56754c08b6",
"md5": "066b774df4d9a05d49c0856927256182",
"sha256": "46cb2813bad39c33f7cbed7394bb16816207e4070eb4e208e5c7e72949ca1661"
},
"downloads": -1,
"filename": "git2doc-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "066b774df4d9a05d49c0856927256182",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10846,
"upload_time": "2023-06-25T20:19:29",
"upload_time_iso_8601": "2023-06-25T20:19:29.858898Z",
"url": "https://files.pythonhosted.org/packages/a5/dc/4571065865d7db022c9e22fca92c6c9ca77d0b5d0a6cf0605b56754c08b6/git2doc-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bed9815d50cc4f5e4518332438e926373529a45cbba01f8b1eef9a2a80719bcb",
"md5": "189f976ca4e0ae7d0089b7977c60aa61",
"sha256": "e6a9d25da0a1b6ae940dc45183333489347cf33c9d99df39bdb25d42c2ccfc21"
},
"downloads": -1,
"filename": "git2doc-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "189f976ca4e0ae7d0089b7977c60aa61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6122,
"upload_time": "2023-06-25T20:19:32",
"upload_time_iso_8601": "2023-06-25T20:19:32.370948Z",
"url": "https://files.pythonhosted.org/packages/be/d9/815d50cc4f5e4518332438e926373529a45cbba01f8b1eef9a2a80719bcb/git2doc-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-25 20:19:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "voynow",
"github_project": "git2doc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "gitpython",
"specs": []
},
{
"name": "python-dotenv",
"specs": []
}
],
"lcname": "git2doc"
}
JSON
