You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
-
*Overview*
1
+
Overview
2
2
============
3
3
4
4
``gitnet`` is a Python 3 package with tools for collecting, cleaning, and exporting datasets from local Git repositories, as well as creating network datasets and visualizations. The primary purpose of ``gitnet`` is to provide scholarly tools to study the collaboration structure of free and open source software development projects, but may also be of use to organizations, project managers, and curious coders.
5
5
6
-
``gitnet`` is currently under active development by the University of Waterloo's NetLab_. The current build offers flexible tools for working with local Git repositories. Future iterations will include support for creating networks using issue report and pull request data, tools for analyzing contributors' communication networks, reproducible data collection, and more tools for increased flexibility. If you are curious about the project, want tips regarding how to use ``gitnet``, find a bug, or wish to request a feature, please feel free to email a contributor or submit an issue report.
6
+
``gitnet`` is currently in active development by the University of Waterloo's NetLab_. The current build offers flexible tools for working with local Git repositories. Future iterations will include support for creating networks using issue report and pull request data, tools for analyzing contributors' communication networks, reproducible data collection, and more tools for increased flexibility. If you are curious about the project, want tips regarding how to use ``gitnet``, find a bug, or wish to request a feature, please feel free to email a contributor or submit an issue report.
7
7
8
8
.. _NetLab: http://networkslab.org/
9
9
10
-
*A Quick (Meta) Example*
10
+
A Quick (Meta) Example
11
11
-------------------------------
12
12
13
13
``gitnet`` makes it easy to collect, clean, and visualize local Git repositories. Here, we used it to create a network visualization of contributions to `.py` files in our Git repository.
@@ -31,14 +31,14 @@ Additionally, you can export data retrieved by gitnet in either ``grapml`` or pl
31
31
32
32
.. image:: resources/gitnet_plot_r.png
33
33
34
-
*Retrieving Data*
34
+
Retrieving Data
35
35
---------------------------
36
36
37
37
Currently, only local Git retrieval is supported. Use the `get_log()` function to create a ``CommitLog`` object, by passing a file path for the Git repository.
The core data class for all data collected by ``gitnet`` is a ``Log``. ``Logs`` contain a core dataset of records, attributes documenting its retrieval, and a number of methods to explore, clean, and export the data it contains. In practice, users will generally use a subclass of the ``Log`` class, with extra features appropriate for the source of their data (e.g. the ``Log`` subclass for Git commit data is called ``CommitLog``, and has methods for generating author-file networks, ignoring files by extension, and so on.)
@@ -77,7 +77,7 @@ The basic methods available for `Log` and all its subclasses are as follows:
77
77
| `.generate_network()` | Creates a network, producing a `MultiGraphPlus` object. |
When you create a network using ``gitnet``, it is represented as a ``MultiGraphPlus`` object, which is a subclass of the networkx_ class for undirected graphs with duplicate edges, the ``MultiGraph``. ``MultiGraphPlus`` inherits all the features of a ``MultiGraph``, and so can be used with all ``networkx`` functions that have ``MultiGraph`` support. However, ``MultiGraphPlus`` defines a number of new methods to make working with ``gitnet`` networks more convenient. The methods unique to ``MultiGraph`` are:
@@ -119,7 +119,7 @@ When you create a network using ``gitnet``, it is represented as a ``MultiGraphP
119
119
| `.write_tnet()` | Exports the network as tnet edgelist for use in R. |
If you want to use the features of `gitnet` for an unsupported data source, it is easy to initialize a `Log` object with a custom dataset. First, convert your data into a dictionary of dictionaries, for example:
@@ -141,15 +141,12 @@ If you wish to request or contribute support for a new data source, please conta
- Pre-alpha, leaving stage two of development and entering stage three.
148
-
- Gitnet is currently in unofficial version 0.0.8. After entering Alpha and publishing an official release, regular updates on feature changes and bug fixes will be published with each version release.
149
-
- Entering the first round of user testing, as of yet all tests done have been either unit testing or internal.
147
+
- Gitnet is currently beta-0.1.1.
150
148
151
-
152
-
*To-Do*
149
+
To-Do
153
150
--------------
154
151
155
152
As a project in development, Gitnet will have a list of potential issues, updates, and features.
0 commit comments