Skip to content

Commit 4b74643

Browse files
committed
Edits to readme.
1 parent 4660eff commit 4b74643

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
*Overview*
1+
Overview
22
============
33

44
``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.
55

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.
77

88
.. _NetLab: http://networkslab.org/
99

10-
*A Quick (Meta) Example*
10+
A Quick (Meta) Example
1111
-------------------------------
1212

1313
``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
3131

3232
.. image:: resources/gitnet_plot_r.png
3333

34-
*Retrieving Data*
34+
Retrieving Data
3535
---------------------------
3636

3737
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.
3838

3939
``my_log = gn.get_log("Users/localpath/my_repository")``
4040

41-
*The Log Class*
41+
The Log Class
4242
-------------------
4343

4444
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:
7777
| `.generate_network()` | Creates a network, producing a `MultiGraphPlus` object. |
7878
+-----------------------+----------------------------------------------------------------------+
7979

80-
*The CommitLog Subclass*
80+
The CommitLog Subclass
8181
-----------------------------
8282

8383
Git commit log datasets are stored as a ``CommitLog``, which inherits all the features of a ``Log`` as well as the following methods:
@@ -94,7 +94,7 @@ Git commit log datasets are stored as a ``CommitLog``, which inherits all the fe
9494
+-----------------------+----------------------------------------------------------------------+
9595

9696

97-
*The MultiGraphPlus Class*
97+
The MultiGraphPlus Class
9898
----------------------------
9999

100100
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
119119
| `.write_tnet()` | Exports the network as tnet edgelist for use in R. |
120120
+-----------------------+----------------------------------------------------------------------+
121121

122-
*Custom Data Sources*
122+
Custom Data Sources
123123
-------------------------
124124

125125
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
141141
.. _here: http://networkslab.org/gitnet/page/documentation/
142142

143143

144-
*Project Status*
144+
Project Status
145145
------------------
146146

147-
- 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.
150148

151-
152-
*To-Do*
149+
To-Do
153150
--------------
154151

155152
As a project in development, Gitnet will have a list of potential issues, updates, and features.

0 commit comments

Comments
 (0)