# 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
```
@INPROCEEDINGS{gote2021gambit,
author={Gote, Christoph and Zingg, Christian},
booktitle={2021 IEEE/ACM 18th International Conference on Mining Software Repositories (MSR)},
title={gambit – An Open Source Name Disambiguation Tool for Version Control Systems},
year={2021},
volume={},
number={},
pages={80-84},
doi={10.1109/MSR52588.2021.00021}
}
```
## 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/gambi",
"name": "gambit-disambig",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "alias disambiguation, repository mining, version control system",
"author": "Christoph Gote",
"author_email": "cgote@ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/29/44/7f825de1d825ecc6d0090cd5f27c1d52ba047b8f2f0b892810ea3c99e423/gambit_disambig-1.0.5.tar.gz",
"platform": null,
"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@INPROCEEDINGS{gote2021gambit,\n author={Gote, Christoph and Zingg, Christian},\n booktitle={2021 IEEE/ACM 18th International Conference on Mining Software Repositories (MSR)}, \n title={gambit \u2013 An Open Source Name Disambiguation Tool for Version Control Systems}, \n year={2021},\n volume={},\n number={},\n pages={80-84},\n doi={10.1109/MSR52588.2021.00021}\n}\n```\n\n## License\n\nThis software is licensed under the GNU Affero General Public License v3 (AGPL-3.0).\n",
"bugtrack_url": null,
"license": "AGPL-3.0+",
"summary": "An Open Source name disambiguation tool for version control systems",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/gotec/gambi"
},
"split_keywords": [
"alias disambiguation",
" repository mining",
" version control system"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4a99342eb2dd9d4b6ea9ec354d807810d765e75ab3b948c308321846033233d",
"md5": "a8520c390c5301a92c78aa0b204fa621",
"sha256": "3abbca041dcbb04a88ee56e91b046f0b09ebdfe4f7b8bad59c3cd625c2384790"
},
"downloads": -1,
"filename": "gambit_disambig-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8520c390c5301a92c78aa0b204fa621",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19814,
"upload_time": "2024-08-21T15:47:22",
"upload_time_iso_8601": "2024-08-21T15:47:22.972744Z",
"url": "https://files.pythonhosted.org/packages/d4/a9/9342eb2dd9d4b6ea9ec354d807810d765e75ab3b948c308321846033233d/gambit_disambig-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29447f825de1d825ecc6d0090cd5f27c1d52ba047b8f2f0b892810ea3c99e423",
"md5": "d4caac9089f3b699ff93690be6887bcf",
"sha256": "d9ad3ad1abe8a089b491b988936988655c25c84cdddb60e10ad4275f70a49847"
},
"downloads": -1,
"filename": "gambit_disambig-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d4caac9089f3b699ff93690be6887bcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18831,
"upload_time": "2024-08-21T15:47:23",
"upload_time_iso_8601": "2024-08-21T15:47:23.902931Z",
"url": "https://files.pythonhosted.org/packages/29/44/7f825de1d825ecc6d0090cd5f27c1d52ba047b8f2f0b892810ea3c99e423/gambit_disambig-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 15:47:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gotec",
"github_project": "gambi",
"github_not_found": true,
"lcname": "gambit-disambig"
}
JSON
