Skip to content

Commit 4612b92

Browse files
author
Maximilian Karl
committed
readme fix for pypi
1 parent 5d40c4a commit 4612b92

File tree

3 files changed

+32
-28
lines changed

3 files changed

+32
-28
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,30 @@ The package implements Python functions for
1111
`github2pandas` stores the collected information in a collection of pandas DataFrames starting from a user defined root folder. The structure beyond that (file names, folder names) is defined as a member variable in the corresponding classes and can be overwritten. The default configuration results in the following file structure.
1212

1313
```
14-
data <- Root directory given as parameter
15-
├── My_Github_Repository_0 <- Repository name
16-
│ ├── Repo.json <- Json file containing user and repo name
17-
│ ├── Issues
18-
│ │ ├── pdIssuesComments.p
19-
│ │ ├── pdIssuesEvents.p
20-
│ │ ├── pdIssues.p
21-
│ │ └── pdIssuesReactions.p
22-
│ ├── PullRequests
23-
│ │ ├── pdPullRequestsComments.p
24-
│ │ ├── pdPullRequestsEvents.p
25-
│ │ ├── pdPullRequests.p
26-
│ │ ├── pdPullRequestsReactions.p
27-
│ │ └── pdPullRequestsReviews.p
28-
│ ├── Users.p
29-
│ ├── Versions
30-
│ │ ├── pdCommits.p
31-
│ │ ├── pdEdits.p
32-
│ │ ├── pdBranches.p
33-
│ │ ├── repo <- Repository clone
34-
│ │ │ ├── ..
35-
│ │ └── Versions.db
36-
│ └── Workflows
37-
│ └── pdWorkflows.p
38-
├── My_Github_Repository_1
14+
|-- My_Github_Repository_0 <- Repository name
15+
| |- Repo.json <- Json file containing user and repo name
16+
| |- Issues
17+
| | |- pdIssuesComments.p
18+
| | |- pdIssuesEvents.p
19+
| | |- pdIssues.p
20+
| | |- pdIssuesReactions.p
21+
| |- PullRequests
22+
| | |- pdPullRequestsComments.p
23+
| | |- pdPullRequestsEvents.p
24+
| | |- pdPullRequests.p
25+
| | |- pdPullRequestsReactions.p
26+
| | |- pdPullRequestsReviews.p
27+
| |- Users.p
28+
| |- Versions
29+
| | |- pdCommits.p
30+
| | |- pdEdits.p
31+
| | |- pdBranches.p
32+
| | |- pVersions.db
33+
| | |- repo <- Repository clone
34+
| | | |- ..
35+
| |- Workflows
36+
| |- pdWorkflows.p
37+
|-- My_Github_Repository_1
3938
...
4039
```
4140
The internal structure and relations of the data frames are included in the project's [wiki](https://github.com/TUBAF-IFI-DiPiT/github2pandas/wiki).

docs/changes.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,13 @@ Version 1.0.2 (April 23, 2021)
1111

1212
* Speed improvemetns
1313

14-
Version 1.0.2 (April 29, 2021)
14+
Version 1.0.3 (April 29, 2021)
1515
-----------------------------------
1616

1717
* documentation improvements
18-
* minor bug fix
18+
* minor bug fix
19+
20+
Version 1.0.31 (April 29, 2021)
21+
-----------------------------------
22+
23+
* readme fix for pypi

github2pandas/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '1.0.3'
1+
__version__ = '1.0.31'

0 commit comments

Comments
 (0)