githubinformation


Namegithubinformation JSON
Version 1.0 PyPI version JSON
download
home_pagehttps://github.com/wfxey/githubinformation
SummaryA tool that lets you check your GitHub Project for updates.
upload_time2024-07-15 23:27:55
maintainerNone
docs_urlNone
authorwfxey
requires_python>=3.9
licenseMIT
keywords updates github check-for-updates
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
<div align="center">
  
# githubinformation

[![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/wfxey/githubrepoinfo#license)  [![PyPi](https://img.shields.io/badge/PyPi%20Link-FFFF00)](https://pypi.org/project/githubrepoinfo/)  <a href="https://github.com/wfxey/githubrepoinfo/blob/master/CONTRIBUTING.md"><img src="https://img.shields.io/github/contributors-anon/wfxey/githubrepoinfo" alt="Contributors badge" /></a>  

A tool that lets you check your GitHub Project for updates.

</div>

## Installation

You can install `githubinformation` using pip:

```bash
pip install githubinformation
```
# .repo

### get_repo_info(owner, repo)

```python
import githubinformation

repo_info = githubinformation.repo.get_repo_info("wfxey", "binaryconvert")
```

### All subinfos

```python
import githubinformation

repo_info = githubinformation.repo.get_repo_info("wfxey", "binaryconvert")

if repo_info:
  print(f"Repository: {repo_info['full_name']}")
  print(f"Description: {get_description(repo_info)}")
  print(f"Stars: {get_stars(repo_info)}")
  print(f"Forks: {get_forks(repo_info)}")
  print(f"Open Issues: {get_open_issues(repo_info)}")
    
repo_link(f"{owner}/{repo}")
```

### Output 

```bash
Repository: wfxey/binaryconvert
Description: A super easy python tool that converts your text in binary language 8x Bit
Stars: 1
Forks: 0
Open Issues: 0
```
<hr>

# .user

### user_link(user)

```python
import githubinformation

githubinformation.user.user_link("wfxey")
```
### Output
```bash
https://github.com/wfxey
```

<hr>

# .release

### release_link(name_and_repo, tag)

```python
import githubinformation

githubinformation.release.release_link("D-I-Projects/diec", "v1.0")
```
### Output 
```bash
https://github.com/D-I-Projects/diec/releases/tag/v1.0
```

<hr>


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/wfxey/githubinformation",
    "name": "githubinformation",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "updates, github, check-for-updates",
    "author": "wfxey",
    "author_email": "projectsdi02@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ee/b1/a0f4b34515b318d73d0db8d98781c7310b318a90b1c82a4bea5207bd285f/githubinformation-1.0.tar.gz",
    "platform": null,
    "description": "\n<div align=\"center\">\n  \n# githubinformation\n\n[![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/wfxey/githubrepoinfo#license)  [![PyPi](https://img.shields.io/badge/PyPi%20Link-FFFF00)](https://pypi.org/project/githubrepoinfo/)  <a href=\"https://github.com/wfxey/githubrepoinfo/blob/master/CONTRIBUTING.md\"><img src=\"https://img.shields.io/github/contributors-anon/wfxey/githubrepoinfo\" alt=\"Contributors badge\" /></a>  \n\nA tool that lets you check your GitHub Project for updates.\n\n</div>\n\n## Installation\n\nYou can install `githubinformation` using pip:\n\n```bash\npip install githubinformation\n```\n# .repo\n\n### get_repo_info(owner, repo)\n\n```python\nimport githubinformation\n\nrepo_info = githubinformation.repo.get_repo_info(\"wfxey\", \"binaryconvert\")\n```\n\n### All subinfos\n\n```python\nimport githubinformation\n\nrepo_info = githubinformation.repo.get_repo_info(\"wfxey\", \"binaryconvert\")\n\nif repo_info:\n  print(f\"Repository: {repo_info['full_name']}\")\n  print(f\"Description: {get_description(repo_info)}\")\n  print(f\"Stars: {get_stars(repo_info)}\")\n  print(f\"Forks: {get_forks(repo_info)}\")\n  print(f\"Open Issues: {get_open_issues(repo_info)}\")\n    \nrepo_link(f\"{owner}/{repo}\")\n```\n\n### Output \n\n```bash\nRepository: wfxey/binaryconvert\nDescription: A super easy python tool that converts your text in binary language 8x Bit\nStars: 1\nForks: 0\nOpen Issues: 0\n```\n<hr>\n\n# .user\n\n### user_link(user)\n\n```python\nimport githubinformation\n\ngithubinformation.user.user_link(\"wfxey\")\n```\n### Output\n```bash\nhttps://github.com/wfxey\n```\n\n<hr>\n\n# .release\n\n### release_link(name_and_repo, tag)\n\n```python\nimport githubinformation\n\ngithubinformation.release.release_link(\"D-I-Projects/diec\", \"v1.0\")\n```\n### Output \n```bash\nhttps://github.com/D-I-Projects/diec/releases/tag/v1.0\n```\n\n<hr>\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A tool that lets you check your GitHub Project for updates.",
    "version": "1.0",
    "project_urls": {
        "Download": "https://github.com/wfxey/githubinformation/archive/refs/tags/v1.0.tar.gz",
        "Homepage": "https://github.com/wfxey/githubinformation"
    },
    "split_keywords": [
        "updates",
        " github",
        " check-for-updates"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "85bc925bcff4a9fae44c5c13ef4b447f20d0d13268f322dfa3199bfe49cba1c1",
                "md5": "50e307c0228abc81b827e166364a04a2",
                "sha256": "6966466b9c0dddcb68cf1d9811ce5594afd3c0f7741088c11ce73ecbabed0c9e"
            },
            "downloads": -1,
            "filename": "githubinformation-1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "50e307c0228abc81b827e166364a04a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4927,
            "upload_time": "2024-07-15T23:27:53",
            "upload_time_iso_8601": "2024-07-15T23:27:53.899263Z",
            "url": "https://files.pythonhosted.org/packages/85/bc/925bcff4a9fae44c5c13ef4b447f20d0d13268f322dfa3199bfe49cba1c1/githubinformation-1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eeb1a0f4b34515b318d73d0db8d98781c7310b318a90b1c82a4bea5207bd285f",
                "md5": "dc5b468b7ad7145896e3c9d1b240dd4a",
                "sha256": "ad9bf42b60e9b58f190c6d467630d60eede1d0479acc6ce30d8d94e23b307f0f"
            },
            "downloads": -1,
            "filename": "githubinformation-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dc5b468b7ad7145896e3c9d1b240dd4a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 3692,
            "upload_time": "2024-07-15T23:27:55",
            "upload_time_iso_8601": "2024-07-15T23:27:55.954069Z",
            "url": "https://files.pythonhosted.org/packages/ee/b1/a0f4b34515b318d73d0db8d98781c7310b318a90b1c82a4bea5207bd285f/githubinformation-1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-15 23:27:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wfxey",
    "github_project": "githubinformation",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "githubinformation"
}
        
Elapsed time: 0.31553s