v1.0.0!

This is the first official release of pyGitAPI. For information about it, read the docs at https://docs.pygitapi.cf.

You can also read this post on dev.to for a basic introduction to this package.

https://dev.to/dillonb07/access-github-graphql-queries-easily-in-python-34j6

pip install --upgrade pygitapi

Links: GitHub - https://github.com/DillonB07/GitAPI PyPi - https://pypi.org/project/pygitapi Docs - https://docs.pygitapi.cf/

Full Changelog: https://github.com/DillonB07/GitAPI/compare/v0.1.1...v1.0.0

This pre-release just closes #15

comment_on_issue() should now work perfectly.

Full Changelog: https://github.com/DillonB07/GitAPI/compare/v1.0.0rc5...v1.0.0rc6

This pre-release adds in two new functions!

• GitAPI.comment_on_issue(owner: str, repo: str, number: int, comment: str)
• GitAPI.get_issue_id(owner: str, repo: str, number: int))

The comment_on_issue() function will return a response with the comment body. This function utilises the get_issue_id() function to find the issue, so you don't need to input the issue ID yourself.

What's Changed

• docs: add kokonut27 as a contributor for code, question, code by @allcontributors in https://github.com/DillonB07/GitAPI/pull/11
• docs: add DillonB07 as a contributor for code, infra, maintenance, test by @allcontributors in https://github.com/DillonB07/GitAPI/pull/12

Full Changelog: https://github.com/DillonB07/GitAPI/compare/v1.0.0rc4...v1.0.0rc5

In this pre-release, I've renamed the module to pygitapi. This is because it isn't just for stats, so it's clearer.

NOTE: The old versions are still available under pygitstats

Install like so:

pip install --upgrade --pre pygitapi

And the main class has been renamed so use it like so:

from pygitapi.graphql import GitAPI

g = GitAPI(token)
...

Full Changelog: https://github.com/DillonB07/GitAPI/compare/v1.0.0rc3...v1.0.0rc4b

In this release candidate, a new function has been added.

Here's a demo!

from pygitstats.graphql import GitStats
import os

token = os.environ['PERSONAL_ACCESS_TOKEN']
g = GitStats(token)

response = g.repo_info(name='GitStats', owner='DillonB07')

print(response['data']['repository']['collaborators'])

Returns:

{'nodes': [{'avatarUrl': 'https://avatars.githubusercontent.com/u/83948303?v=4', 'login': 'DillonB07', 'name': 'Dillon Barnes', 'url': 'https://github.com/DillonB07'}], 'totalCount': 1}

You can install/upgrade to v1.0.0rc3 like so:

pip install --upgrade --pre pygitstats

Full Changelog: https://github.com/DillonB07/GitStats/compare/v0.1.0rc2...v1.0.0rc3

In this release candidate, the module has been changed back to the requests module. Also, #3 is finally closed for good, hopefully.

You can install/upgrade this module like so:

pip install --upgrade --pre pygitstats

Full Changelog: https://github.com/DillonB07/GitStats/compare/v1.0.0rc1...v1.0.0rc2

This is v1.0.0 Release Candidate 1.

~The major change in this release is that the project has moved to a new library meaning that GraphQL responses are now Python dictionaries. - Closes #3~ This has been proved wrong via some testing - Reopened #3

This should not affect usage as all of the functions in the module do the same thing and have the same name.

As this is a pre-release, you will need to add the --pre flag when installing from pip like so:

pip install --upgrade --pre pygitstats

Full Changelog: https://github.com/DillonB07/GitStats/compare/v0.1.1...v1.0.0rc1

This fixes a bug where the response was printed instead of returned! 🤦

Full Changelog: https://github.com/DillonB07/GitStats/compare/v0.1.0...v0.1.1

GitStats

This is the first release of GitStats.

Usage

In this release, you can grab generic data about a user using GitStats.user_info() Here is an example:

from pygitstats.graphql import GitStats
import os

g = GitStats(os.environ['GITHUB_PERSONAL_ACCESS_TOKEN']) # Don't store your Personal Access Token in plain text!

user_info = g.user_info('DillonB07') # User to get info on
print(user_info)

You can also use custom GraphQL queries like so:

from pygitstats.graphql import GitStats
import os

username = 'DillonB07'
query = '''
query repo_count {
  user(login: "''' + username + '''") {
    repositories {
      totalCount
    }
  }
}
'''

g = GitStats(os.environ['GITHUB_PERSONAL_ACCESS_TOKEN']) # Don't store your Personal Access Token in plain text!

total_repos = g.custom_query(query) # Custom query will return the amount of repositories the user has
print(total_repos)

Remember: DO NOT STORE YOUR PERSONAL ACCESS TOKEN IN YOUR PROGRAM! 0adfd2d

Installation

This package can be installed from PyPi via one of the following commands:

Pip

pip install pygitstats

pip3 install pygitstats

python -m pip install pygitstats

python3 -m pip install pygitstats

Poetry

poetry install pygitstats

Conda

conda install pygitstats

Pipenv

pipenv install pygitstats

Credit

Feedback and suggestions for the package would be appreciated!

Credit to @JBYT27 for GitAPI which inspired this project. I've also taken(and modified) some code from that repo.