### Library use
After downloading and configuring the library, we can start using it.
First let's import the library into the project.
```python
from pyGitInfo import *
```
### Notes/Standardization
**Date:** The default format for passing dates is "month-day-year" Ex: "06-07-2023" is equivalent to June 07, 2023
### Functions and Returns
- **get_commits_by_user()**
Allows you to search for commits by user, passing 3 strings as a parameter, the user's name (str), a start date and an end date.
```python
get_commits_by_user('name_user','date_init','date_end')
```
This function returns _DataFrame_ from the _Pandas_ library or an error message
- **get_commits_users()**
Allows you to search for commits from all contributors, passing as a parameter 2 strings that define the time range, a start date and an end date.
```python
get_commits_users('date_init','date_end')
```
This function returns _DataFrame_ from the _Pandas_ library
- **get_coAuthor()**
Search all commits with Coauthor, passing as parameters 2 strings that define the time range, a start date and an end date.
```python
get_coAuthor('date_init','date_end')
```
This function returns a _DataFrame_ from the _Pandas_ library or an error message
- **issues_month()**
This function verifies how many Issues were closed per month, within the stipulated period. The function receives 2 date strings as a parameter, the start and end date.
```python
issues_month('date_init','date_end')
```
The function returns _DataFrame_ from the _Pandas_ library and also generates a png graphic
- **calculate_commit_average()**
Calculates the average commits across all contributors and shows who is above or below that average. You must pass the analysis period as a parameter with 2 strings representing the dates
```python
calculate_commit_average('date_init','date_end')
```
The function returns _DataFrame_ from the _Pandas_ library and also generates a png graphic
- **commit_data()**
Searches for all commits on a specific day, the function receives a string with the desired date as a parameter.
```python
commit_data('date')
```
The function generates a markdown file with the information
- **commit_palavra()**
Searches for all commits (within a time range) that have the desired word in their description. This function receives 3 strings as a parameter, the first with the 'word' to be searched for, and the 2 'dates' referring to the time interval
```python
commit_palavra('palavra','date_init','date_end')
```
The function returns a _DataFrame_ from the _Pandas_ library or an error message
- **check_extension()**
It does a search for the files that are being committed by each contributor and classifies them according to their extension. You must pass the time interval for the analysis (2 strings of 'date')
```python
check_extension('date_init','date_end')
```
The function returns a variable with the content written in markdown format
- **title_commits()**
Searches all commit titles, by user, thus facilitating the visualization of what each contributor has done (Requires a time interval) 2 strings 'data'
```python
title_commits('date_init','date_end')
```
The function returns a variable with the content written in markdown format
- **gerenate_report()**
Combines the functions of commit with coauthor and overall average to generate a more complete report. The function receives as parameter 2 date strings with the time interval to be analyzed ('initial_date','final_date')
```python
gerenate_report('date_init','date_end')
```
Generates a "gitInfo_report.md" markdown with information about commits with coauthor and the number of commits per user
- **issues_open()**
Searches all Issues that are open but have not yet been signed by anyone. It takes nothing as a parameter.
```python
issues_open()
```
The function returns a variable with the content written in markdown format
Raw data
{
"_id": null,
"home_page": "",
"name": "pyGitInfo",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "gitInfo,github,git,relatorio,reports,gitReports",
"author": "['Catlen Cleane', 'Felipe Direito', 'Gabriel Rosa', 'Gabriel Zaranza', 'Rafael Kenji', 'Lucas Lob\u00e3o', 'Vinicius de Oliveira']",
"author_email": "catlen.cleane@hotmail.com, fedireito92@gmail.com, gabriel10919@outlook.com, gabrielzaranza@hotmail.com, rafak.taira@gmail.com, lucaslobao14df@gmail.com, viniciusoliveirasp22@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/80/d7/47af57c3dcb058c22f96c506ba7bba614500d6fc3c0ae4ab5a20f7a07e6f/pyGitInfo-0.0.6.tar.gz",
"platform": null,
"description": "### Library use\r\n\r\nAfter downloading and configuring the library, we can start using it. \r\n\r\nFirst let's import the library into the project. \r\n\r\n```python\r\nfrom pyGitInfo import *\r\n``` \r\n\r\n### Notes/Standardization \r\n\r\n**Date:** The default format for passing dates is \"month-day-year\" Ex: \"06-07-2023\" is equivalent to June 07, 2023 \r\n\r\n### Functions and Returns \r\n\r\n- **get_commits_by_user()** \r\n Allows you to search for commits by user, passing 3 strings as a parameter, the user's name (str), a start date and an end date. \r\n\r\n ```python\r\n get_commits_by_user('name_user','date_init','date_end')\r\n ``` \r\n \r\n This function returns _DataFrame_ from the _Pandas_ library or an error message \r\n\r\n- **get_commits_users()** \r\n Allows you to search for commits from all contributors, passing as a parameter 2 strings that define the time range, a start date and an end date. \r\n\r\n ```python\r\n get_commits_users('date_init','date_end')\r\n ``` \r\n\r\n This function returns _DataFrame_ from the _Pandas_ library \r\n\r\n- **get_coAuthor()** \r\n Search all commits with Coauthor, passing as parameters 2 strings that define the time range, a start date and an end date. \r\n\r\n ```python\r\n get_coAuthor('date_init','date_end')\r\n ``` \r\n\r\n This function returns a _DataFrame_ from the _Pandas_ library or an error message \r\n\r\n- **issues_month()** \r\n This function verifies how many Issues were closed per month, within the stipulated period. The function receives 2 date strings as a parameter, the start and end date.\r\n\r\n ```python\r\n issues_month('date_init','date_end')\r\n ``` \r\n\r\n The function returns _DataFrame_ from the _Pandas_ library and also generates a png graphic\r\n\r\n- **calculate_commit_average()** \r\n Calculates the average commits across all contributors and shows who is above or below that average. You must pass the analysis period as a parameter with 2 strings representing the dates\r\n\r\n ```python\r\n calculate_commit_average('date_init','date_end')\r\n ``` \r\n\r\n The function returns _DataFrame_ from the _Pandas_ library and also generates a png graphic\r\n\r\n- **commit_data()** \r\n Searches for all commits on a specific day, the function receives a string with the desired date as a parameter.\r\n\r\n ```python\r\n commit_data('date')\r\n ``` \r\n\r\n The function generates a markdown file with the information\r\n\r\n- **commit_palavra()** \r\n Searches for all commits (within a time range) that have the desired word in their description. This function receives 3 strings as a parameter, the first with the 'word' to be searched for, and the 2 'dates' referring to the time interval\r\n\r\n ```python\r\n commit_palavra('palavra','date_init','date_end')\r\n ``` \r\n\r\n The function returns a _DataFrame_ from the _Pandas_ library or an error message \r\n\r\n- **check_extension()** \r\n It does a search for the files that are being committed by each contributor and classifies them according to their extension. You must pass the time interval for the analysis (2 strings of 'date')\r\n\r\n ```python\r\n check_extension('date_init','date_end')\r\n ``` \r\n\r\n The function returns a variable with the content written in markdown format\r\n\r\n- **title_commits()** \r\n Searches all commit titles, by user, thus facilitating the visualization of what each contributor has done (Requires a time interval) 2 strings 'data'\r\n\r\n ```python\r\n title_commits('date_init','date_end')\r\n ``` \r\n\r\n The function returns a variable with the content written in markdown format \r\n\r\n- **gerenate_report()** \r\n Combines the functions of commit with coauthor and overall average to generate a more complete report. The function receives as parameter 2 date strings with the time interval to be analyzed ('initial_date','final_date')\r\n\r\n ```python\r\n gerenate_report('date_init','date_end')\r\n ``` \r\n\r\n Generates a \"gitInfo_report.md\" markdown with information about commits with coauthor and the number of commits per user\r\n\r\n- **issues_open()** \r\n Searches all Issues that are open but have not yet been signed by anyone. It takes nothing as a parameter.\r\n\r\n ```python\r\n issues_open()\r\n ``` \r\n\r\n The function returns a variable with the content written in markdown format \r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Analisador de reposit\u00f3rios do github",
"version": "0.0.6",
"project_urls": null,
"split_keywords": [
"gitinfo",
"github",
"git",
"relatorio",
"reports",
"gitreports"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80d747af57c3dcb058c22f96c506ba7bba614500d6fc3c0ae4ab5a20f7a07e6f",
"md5": "bfd48807c8e1a0083f33956118299d22",
"sha256": "a01103fd547685e76e84eb045301149ad231d28502bec46b5808ef49d7ac88b3"
},
"downloads": -1,
"filename": "pyGitInfo-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "bfd48807c8e1a0083f33956118299d22",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5894,
"upload_time": "2023-07-17T13:22:32",
"upload_time_iso_8601": "2023-07-17T13:22:32.963243Z",
"url": "https://files.pythonhosted.org/packages/80/d7/47af57c3dcb058c22f96c506ba7bba614500d6fc3c0ae4ab5a20f7a07e6f/pyGitInfo-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-17 13:22:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pygitinfo"
}
JSON