# git-user
### Purpose of the Package
A Python library for GitHub API integration. Retrieve user info, repositories, and more. Simplify GitHub-related tasks effortlessly.
### Features
- ------List of functions------
- format_username(username)
- confirm_username(username)
- get_response(username)
- full_name(username)
- twitter(username)
- repos(username)
- bio(username)
- location(username)
- repo_count(username)
- followers_count(username)
- following_count(username)
- joined_date(username)
- confirm_token(username, token)
- create_repo(username, token, repo_name)
### Dependencies
Python >3
Request `pip install requests`
### Getting Started
The package can be found on pypi hence you can install it using pip
### Installation
```bash
pip install git_user23
```
# How to use
## List of functions
format_username(username)
This function removes leading and trailing spaces from the given username.
```python
>>> from git_user23 import *
>>> format_username(" samuelogboye")
'samuelogboye'
>>> format_username(" samuelogboye ")
'samuelogboye'
```
confirm_username(username)
Checks if a given username is valid on GitHub.
```python
>>> from git_user23 import *
>>> confirm_username("samuelogboye")
True
>>> confirm_username("samuelogboy")
False
```
get_response(username)
Retrieves all user information from GitHub API and returns it as a dictionary.
```python
>>> from git_user23 import *
>>> get_response("samuelogboye")
info
```
full_name(username)
Retrieves the full name of the user
```python
>>> from git_user23 import *
>>> full_name("samuelogboye")
'Samuel Ogboye'
```
twitter(username)
Retrieves the twitter username of a user
```python
>>> from git_user23 import *
>>> twitter("samuelogboye")
'samuel_ogboye'
```
repos(username)
Retrieves a list of all repositories owned by the user.
```python
>>> from git_user23 import *
>>> repos("samuelogboye")
list of repo
```
bio(username)
Retrieves the bio of the user
```python
>>> from git_user23 import *
>>> bio("samuelogboye")
'Software Engineer || Open Source || Technical Writer || C || Python'
```
location(username)
Retrieves the location of the user.
```python
>>> from git_user23 import *
>>> location("samuelogboye")
'Nigeria'
```
repo_count(username)
Retrives the count of public repositories owned by the user.
```python
>>> from git_user23 import *
>>> repo_count("samuelogboye")
30
```
followers_count(username)
Retrieves the count of followers of the user.
```python
>>> from git_user23 import *
>>> followers_count("samuelogboye")
75
```
following_count(username)
Retrieves the count of users that the user is following.
```python
>>> from git_user23 import *
>>> following_count("samuelogboye")
64
```
joined_date(username)
Retrieves the date when the user joined GitHub.
```python
>>> from git_user23 import *
>>> joined_date("samuelogboye")
'2023-02-16'
```
confirm_token(username, token)
Confirms if both username and token are valid. Returns True or False
```python
>>> from git_user23 import *
>>> confirm_token("samuelogboye", *********)
False
```
create_repo(username, token, repo_name)
Creates a public GitHub repository instantly with a README file and returns True if successful.
```python
>>> from git_user23 import *
>>> create_repo("samuelogboye", "******", "testing")
True
```
### Contribution
Contributions are welcome
Notice a bug, let us know. Thanks
### Author
- Main Maintainer: Samuel Ogboye
- Jesus Saves
Raw data
{
"_id": null,
"home_page": "https://github.com/samuelogboye/git-user",
"name": "git-user23",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3,<4",
"maintainer_email": "",
"keywords": "github,api,user,repository,git,python,library,wrapper,integration,samuelogboye",
"author": "Samuel Ogboye",
"author_email": "ogboyesam@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/95/15/08d80695df81d66108bd9b0c8fdfeddafc89a46def141743ec815cc967b0/git-user23-0.0.3.tar.gz",
"platform": null,
"description": "# git-user\n\n### Purpose of the Package\n\nA Python library for GitHub API integration. Retrieve user info, repositories, and more. Simplify GitHub-related tasks effortlessly.\n\n### Features\n\n- ------List of functions------\n - format_username(username)\n - confirm_username(username)\n - get_response(username)\n - full_name(username)\n - twitter(username)\n - repos(username)\n - bio(username)\n - location(username)\n - repo_count(username)\n - followers_count(username)\n - following_count(username)\n - joined_date(username)\n - confirm_token(username, token)\n - create_repo(username, token, repo_name)\n\n### Dependencies\n\nPython >3\nRequest `pip install requests`\n\n### Getting Started\n\nThe package can be found on pypi hence you can install it using pip\n\n### Installation\n\n```bash\npip install git_user23\n```\n\n# How to use\n\n## List of functions\n\nformat_username(username)\nThis function removes leading and trailing spaces from the given username.\n\n```python\n>>> from git_user23 import *\n>>> format_username(\" samuelogboye\")\n'samuelogboye'\n>>> format_username(\" samuelogboye \")\n'samuelogboye'\n```\n\nconfirm_username(username)\nChecks if a given username is valid on GitHub.\n\n```python\n>>> from git_user23 import *\n>>> confirm_username(\"samuelogboye\")\nTrue\n>>> confirm_username(\"samuelogboy\")\nFalse\n```\n\nget_response(username)\nRetrieves all user information from GitHub API and returns it as a dictionary.\n\n```python\n>>> from git_user23 import *\n>>> get_response(\"samuelogboye\")\ninfo\n```\n\nfull_name(username)\nRetrieves the full name of the user\n\n```python\n>>> from git_user23 import *\n>>> full_name(\"samuelogboye\")\n'Samuel Ogboye'\n\n```\n\ntwitter(username)\nRetrieves the twitter username of a user\n\n```python\n>>> from git_user23 import *\n>>> twitter(\"samuelogboye\")\n'samuel_ogboye'\n\n```\n\nrepos(username)\nRetrieves a list of all repositories owned by the user.\n\n```python\n>>> from git_user23 import *\n>>> repos(\"samuelogboye\")\nlist of repo\n\n```\n\nbio(username)\nRetrieves the bio of the user\n\n```python\n>>> from git_user23 import *\n>>> bio(\"samuelogboye\")\n'Software Engineer || Open Source || Technical Writer || C || Python'\n\n```\n\nlocation(username)\nRetrieves the location of the user.\n\n```python\n>>> from git_user23 import *\n>>> location(\"samuelogboye\")\n'Nigeria'\n\n```\n\nrepo_count(username)\nRetrives the count of public repositories owned by the user.\n\n```python\n>>> from git_user23 import *\n>>> repo_count(\"samuelogboye\")\n30\n\n```\n\nfollowers_count(username)\nRetrieves the count of followers of the user.\n\n```python\n>>> from git_user23 import *\n>>> followers_count(\"samuelogboye\")\n75\n\n```\n\nfollowing_count(username)\nRetrieves the count of users that the user is following.\n\n```python\n>>> from git_user23 import *\n>>> following_count(\"samuelogboye\")\n64\n\n```\n\njoined_date(username)\nRetrieves the date when the user joined GitHub.\n\n```python\n>>> from git_user23 import *\n>>> joined_date(\"samuelogboye\")\n'2023-02-16'\n\n```\n\nconfirm_token(username, token)\nConfirms if both username and token are valid. Returns True or False\n\n```python\n>>> from git_user23 import *\n>>> confirm_token(\"samuelogboye\", *********)\nFalse\n\n```\n\ncreate_repo(username, token, repo_name)\nCreates a public GitHub repository instantly with a README file and returns True if successful.\n\n```python\n>>> from git_user23 import *\n>>> create_repo(\"samuelogboye\", \"******\", \"testing\")\nTrue\n\n```\n\n### Contribution\n\nContributions are welcome\nNotice a bug, let us know. Thanks\n\n### Author\n\n- Main Maintainer: Samuel Ogboye\n- Jesus Saves\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python library for GitHub API integration. Retrieve user info, repositories, and more. Simplify GitHub-related tasks effortlessly.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/samuelogboye/git-user",
"Repository": "https://github.com/samuelogboye/git-user"
},
"split_keywords": [
"github",
"api",
"user",
"repository",
"git",
"python",
"library",
"wrapper",
"integration",
"samuelogboye"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "832db02fea57e76b8918ebd51880f6fe310d58f8956ecf9375a49ba2435b0381",
"md5": "a97ed189b698871934db3889e13b2a2b",
"sha256": "910021821ff7db75a51273cad106dbb89502ec2e65a318d4c8aaf2e86e32188a"
},
"downloads": -1,
"filename": "git_user23-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a97ed189b698871934db3889e13b2a2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3,<4",
"size": 4247,
"upload_time": "2023-09-10T01:32:43",
"upload_time_iso_8601": "2023-09-10T01:32:43.113459Z",
"url": "https://files.pythonhosted.org/packages/83/2d/b02fea57e76b8918ebd51880f6fe310d58f8956ecf9375a49ba2435b0381/git_user23-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "951508d80695df81d66108bd9b0c8fdfeddafc89a46def141743ec815cc967b0",
"md5": "6c1b41b0c3e42ee7ace019a8382f2d09",
"sha256": "f29e8131ce9cf75f660f0ee9ea75ef7cfee38b022b268b6b76c4d137e78dfe22"
},
"downloads": -1,
"filename": "git-user23-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6c1b41b0c3e42ee7ace019a8382f2d09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3,<4",
"size": 4541,
"upload_time": "2023-09-10T01:32:41",
"upload_time_iso_8601": "2023-09-10T01:32:41.415037Z",
"url": "https://files.pythonhosted.org/packages/95/15/08d80695df81d66108bd9b0c8fdfeddafc89a46def141743ec815cc967b0/git-user23-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-10 01:32:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samuelogboye",
"github_project": "git-user",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "git-user23"
}
JSON
