gambit-disambig


Namegambit-disambig JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/gotec/gambit
SummaryAn Open Source name disambiguation tool for version control systems
upload_time2021-04-26 08:53:14
maintainer
docs_urlNone
authorChristoph Gote
requires_python
licenseAGPL-3.0+
keywords alias disambiguation repository mining version control system
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # gambit

`gambit` is an Open Source name disambiguation tool for version control systems.

## Download and installation

`gambit` is pure `python` code. It has no platform-specific dependencies and thus works on all
platforms. Assuming you are using `pip`, you can install latest version of `gambit` by running:

```
> pip install gambit-disambig
```

This also installs the necessary dependencies. `gambit` depends on the `python-Levenshtein` package to compute Levenshtein distances for edited lines of code. On sytems running Windows, automatically compiling this C based module might fail during installation. In this case, unofficial Windows binaries can be found [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#python-levenshtein), which might help you get started.

## How to use gambit
After installation, we suggest to check out our [tutorial](https://github.com/gotec/gambit/blob/master/TUTORIAL.ipynb), detailing how to get started using `gambit`. We also provide detailed inline documentation serving as reference.

We have published some motivating results as well as details on the disambiguation algorithm and its hyperparameters in ["gambit – An Open Source Name Disambiguation Tool for Version Control Systems"](https://arxiv.org/abs/2103.05666). An earlier version of gambit used to obtain the results shown in our paper is archived on [zenodo.org](http://doi.org/10.5281/zenodo.4384646).
Due to GDPR, we cannot publish the manually disambiguated ground-truth data on zenodo. However, if you require this data for research purposes or replication of our results please feel free to contact us directly.

All functions of `gambit` have been tested on Ubuntu, Mac OS, and Windows.

## How to cite gambit

```
@misc{gote2021gambit,
      title={gambit -- An Open Source Name Disambiguation Tool for Version Control Systems}, 
      author={Christoph Gote and Christian Zingg},
      year={2021},
      eprint={2103.05666},
      archivePrefix={arXiv},
      primaryClass={cs.SE}
}
```

## License

This software is licensed under the GNU Affero General Public License v3 (AGPL-3.0).



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gotec/gambit",
    "name": "gambit-disambig",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "alias disambiguation repository mining version control system",
    "author": "Christoph Gote",
    "author_email": "cgote@ethz.ch",
    "download_url": "",
    "platform": "",
    "description": "# gambit\n\n`gambit` is an Open Source name disambiguation tool for version control systems.\n\n## Download and installation\n\n`gambit` is pure `python` code. It has no platform-specific dependencies and thus works on all\nplatforms. Assuming you are using `pip`, you can install latest version of `gambit` by running:\n\n```\n> pip install gambit-disambig\n```\n\nThis also installs the necessary dependencies. `gambit` depends on the `python-Levenshtein` package to compute Levenshtein distances for edited lines of code. On sytems running Windows, automatically compiling this C based module might fail during installation. In this case, unofficial Windows binaries can be found [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#python-levenshtein), which might help you get started.\n\n## How to use gambit\nAfter installation, we suggest to check out our [tutorial](https://github.com/gotec/gambit/blob/master/TUTORIAL.ipynb), detailing how to get started using `gambit`. We also provide detailed inline documentation serving as reference.\n\nWe have published some motivating results as well as details on the disambiguation algorithm and its hyperparameters in [\"gambit \u2013 An Open Source Name Disambiguation Tool for Version Control Systems\"](https://arxiv.org/abs/2103.05666). An earlier version of gambit used to obtain the results shown in our paper is archived on [zenodo.org](http://doi.org/10.5281/zenodo.4384646).\nDue to GDPR, we cannot publish the manually disambiguated ground-truth data on zenodo. However, if you require this data for research purposes or replication of our results please feel free to contact us directly.\n\nAll functions of `gambit` have been tested on Ubuntu, Mac OS, and Windows.\n\n## How to cite gambit\n\n```\n@misc{gote2021gambit,\n      title={gambit -- An Open Source Name Disambiguation Tool for Version Control Systems}, \n      author={Christoph Gote and Christian Zingg},\n      year={2021},\n      eprint={2103.05666},\n      archivePrefix={arXiv},\n      primaryClass={cs.SE}\n}\n```\n\n## License\n\nThis software is licensed under the GNU Affero General Public License v3 (AGPL-3.0).\n\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0+",
    "summary": "An Open Source name disambiguation tool for version control systems",
    "version": "1.0.3",
    "split_keywords": [
        "alias",
        "disambiguation",
        "repository",
        "mining",
        "version",
        "control",
        "system"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "97b38be0b039473c8da465c20235b29b",
                "sha256": "182eeeb545ec80837f4f8d7c2b7d0d20ed213a47f43e1a7dd811b8089eec5927"
            },
            "downloads": -1,
            "filename": "gambit_disambig-1.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "97b38be0b039473c8da465c20235b29b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19896,
            "upload_time": "2021-04-26T08:53:14",
            "upload_time_iso_8601": "2021-04-26T08:53:14.170431Z",
            "url": "https://files.pythonhosted.org/packages/21/ed/eb0804b35788cff953461b320f70b0e80252519b2398ca6575d1702cf52a/gambit_disambig-1.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-26 08:53:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "gotec",
    "error": "Could not fetch GitHub repository",
    "lcname": "gambit-disambig"
}
        
Elapsed time: 0.31839s