get-github-code


Nameget-github-code JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/Vlad2030/get-code-from-github
Summarya small python library to get code from github repositories.
upload_time2023-05-14 23:18:46
maintainer
docs_urlNone
authorvladdd0
requires_python>=3.10.0,<4.0.0
licenseGNU
keywords urllib3 aiohttp asyncio orjson
VCS
bugtrack_url
requirements urllib3 aiohttp asyncio orjson
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ## Get code from GitHub
[![pypi](https://img.shields.io/pypi/v/get_github_code)](https://pypi.org/project/get-github-code/)
[![](https://img.shields.io/pypi/pyversions/get_github_code)](https://pypi.org/project/get-github-code/)
[![CodeFactor](https://www.codefactor.io/repository/github/vlad2030/get-code-from-github/badge/main)](https://www.codefactor.io/repository/github/vlad2030/get-code-from-github/overview/main)

this is a small python library to get code from github repositories

## How to install
```bash
pip3 install get_github_code
```

## Usage
is easy to use

```python
from get_github_code import get_code

code = get_code(
    user="Vlad2030",
    repo="get-code-from-github",
    branch="main",
    file_path="VERSION",
)

print(code)
# 0.2.1
```

or asynchronous

```python
import asyncio
from get_github_code import async_get_code

async def main() -> None:
    code = await async_get_code(
        user="Vlad2030",
        repo="get-code-from-github",
        branch="main",
        file_path="VERSION",
    )

    print(code)

asyncio.run(main())
# 0.2.1
```

additionally you can through the class by calling property

```python
import asyncio
from get_github_code import GetCode

file = GetCode(
    user="Vlad2030",
    repo="get-code-from-github",
    branch="main",
    file_path="VERSION",
)

print(file.get_code)
# 0.2.1

async def main() -> None:
    file = GetCode(
        user="Vlad2030",
        repo="get-code-from-github",
        branch="main",
        file_path="VERSION",
    )

    print(file.async_get_code)

asyncio.run(main())
# 0.2.1
```

## Documentation
[How to install](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/install.md)

[Classes/GetCode](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/classes/GetCode.md)

[functions/get_code](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/functions/get_code.md)

[functions/async_get_code](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/functions/async_get_code.md)


> 2023, version 0.2.1

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Vlad2030/get-code-from-github",
    "name": "get-github-code",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10.0,<4.0.0",
    "maintainer_email": "",
    "keywords": "urllib3,aiohttp,asyncio,orjson",
    "author": "vladdd0",
    "author_email": "vlad123123v@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c6/2f/847b366961ff7963e6f6db8e86d834d155ee868d25cf09ae231fc4f644a4/get_github_code-0.2.1.tar.gz",
    "platform": null,
    "description": "## Get code from GitHub\n[![pypi](https://img.shields.io/pypi/v/get_github_code)](https://pypi.org/project/get-github-code/)\n[![](https://img.shields.io/pypi/pyversions/get_github_code)](https://pypi.org/project/get-github-code/)\n[![CodeFactor](https://www.codefactor.io/repository/github/vlad2030/get-code-from-github/badge/main)](https://www.codefactor.io/repository/github/vlad2030/get-code-from-github/overview/main)\n\nthis is a small python library to get code from github repositories\n\n## How to install\n```bash\npip3 install get_github_code\n```\n\n## Usage\nis easy to use\n\n```python\nfrom get_github_code import get_code\n\ncode = get_code(\n    user=\"Vlad2030\",\n    repo=\"get-code-from-github\",\n    branch=\"main\",\n    file_path=\"VERSION\",\n)\n\nprint(code)\n# 0.2.1\n```\n\nor asynchronous\n\n```python\nimport asyncio\nfrom get_github_code import async_get_code\n\nasync def main() -> None:\n    code = await async_get_code(\n        user=\"Vlad2030\",\n        repo=\"get-code-from-github\",\n        branch=\"main\",\n        file_path=\"VERSION\",\n    )\n\n    print(code)\n\nasyncio.run(main())\n# 0.2.1\n```\n\nadditionally you can through the class by calling property\n\n```python\nimport asyncio\nfrom get_github_code import GetCode\n\nfile = GetCode(\n    user=\"Vlad2030\",\n    repo=\"get-code-from-github\",\n    branch=\"main\",\n    file_path=\"VERSION\",\n)\n\nprint(file.get_code)\n# 0.2.1\n\nasync def main() -> None:\n    file = GetCode(\n        user=\"Vlad2030\",\n        repo=\"get-code-from-github\",\n        branch=\"main\",\n        file_path=\"VERSION\",\n    )\n\n    print(file.async_get_code)\n\nasyncio.run(main())\n# 0.2.1\n```\n\n## Documentation\n[How to install](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/install.md)\n\n[Classes/GetCode](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/classes/GetCode.md)\n\n[functions/get_code](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/functions/get_code.md)\n\n[functions/async_get_code](https://github.com/Vlad2030/get-code-from-github/blob/main/docs/functions/async_get_code.md)\n\n\n> 2023, version 0.2.1",
    "bugtrack_url": null,
    "license": "GNU",
    "summary": "a small python library to get code from github repositories.",
    "version": "0.2.1",
    "project_urls": {
        "Documentation": "https://get-code-from-github.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/Vlad2030/get-code-from-github",
        "Repository": "https://github.com/Vlad2030/get-code-from-github"
    },
    "split_keywords": [
        "urllib3",
        "aiohttp",
        "asyncio",
        "orjson"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e9e18e3f11f8672fed20989acc0b0fca3e29be16be0f4c9f888b1a9ead0f580e",
                "md5": "ad2ede628d48fcc3f3c97f9742ad4f69",
                "sha256": "fac887e3e6b09d8825a64fec128cd4f6411cf21997510d5e5777eaf8c065fe43"
            },
            "downloads": -1,
            "filename": "get_github_code-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad2ede628d48fcc3f3c97f9742ad4f69",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0,<4.0.0",
            "size": 18595,
            "upload_time": "2023-05-14T23:18:44",
            "upload_time_iso_8601": "2023-05-14T23:18:44.284830Z",
            "url": "https://files.pythonhosted.org/packages/e9/e1/8e3f11f8672fed20989acc0b0fca3e29be16be0f4c9f888b1a9ead0f580e/get_github_code-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c62f847b366961ff7963e6f6db8e86d834d155ee868d25cf09ae231fc4f644a4",
                "md5": "3def6f109b20a4d7f7cc7d0b7bebff94",
                "sha256": "420b018cfbfb2ef3b7e429214349e02a799ac8c3c393c5735b38cee9d09340a3"
            },
            "downloads": -1,
            "filename": "get_github_code-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3def6f109b20a4d7f7cc7d0b7bebff94",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0,<4.0.0",
            "size": 16426,
            "upload_time": "2023-05-14T23:18:46",
            "upload_time_iso_8601": "2023-05-14T23:18:46.110028Z",
            "url": "https://files.pythonhosted.org/packages/c6/2f/847b366961ff7963e6f6db8e86d834d155ee868d25cf09ae231fc4f644a4/get_github_code-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-14 23:18:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Vlad2030",
    "github_project": "get-code-from-github",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "urllib3",
            "specs": [
                [
                    "==",
                    "1.26.5"
                ]
            ]
        },
        {
            "name": "aiohttp",
            "specs": [
                [
                    "==",
                    "3.8.3"
                ]
            ]
        },
        {
            "name": "asyncio",
            "specs": [
                [
                    "==",
                    "3.4.3"
                ]
            ]
        },
        {
            "name": "orjson",
            "specs": [
                [
                    "==",
                    "3.5.2"
                ]
            ]
        }
    ],
    "lcname": "get-github-code"
}
vladdd0
Elapsed time: 0.07601s