# Anubis, a codemetrics tool.
You can read more about anubisgit on the [internal docummentation page page](http://open-source.pg.cerfacs.fr/anubisgit/).
##### Work in progress
Today, Anubis is essentially the script `timemachine.py`.
the time machine is a loop can spawn various versions of a code from its gitbase, and perform analysis on it
##### Installation
Anubis I under fast development, and we do not update PiPY very often.
For a quick installation in a simplified virtual environment
```bash
python3 -m venv venv_anubisgit
source venv_anubisgit/bin/activate
python -m pip install 'anubisgit @ git+https://gitlab.com/cerfacs/anubisgit.git'
```
You can obiously install it from the sources available on [gitlab.com](https://gitlab.com/cerfacs/anubisgit)
##### main Usage
For now , there is a minimal CLI, limited to the execution of the time machine of Anubis
Type `>anubisgit` to see what is available :
```bash
>anubisgit
Usage: anubisgit [OPTIONS] COMMAND [ARGS]...
Package anubisgit v0.7.0
--------------- Anubis --------------------
You are now using the Command line interface of anubisgit package, a
set of tools created at CERFACS (https://cerfacs.fr).
This is a python package currently installed in your python
environement.
Options:
--help Show this message and exit.
Commands:
anew Create a default input file in current folder.
authors-list Retrieve authors list from joined_commits_monthly.json
branches Analyze branch health
chronology Code geology
complexity Analyse code health
join-db Join Anubis database
timemachine Build anubisgit database
```
If your new to anubisgit, you can find a quick how to tutorial [there](/docs/howto/howto_anubisgit.md)
##### Good practice
Althought anubisgit timemachine cli command won't let you start a run if your repository is not clean. It is highly recommended to git clone the repository you want to analyze and have a repository for your work repository to avoid any unwanted behaviour or file deletion during the timemachine process.
##### Most common troubleshoots
- Unclean repository
- .gitignore
##### Acknowledgements
This work has been initially supported by the [COEC project](https://www.hpccoe.eu/coec/) which has received funding from the European Union’s Horizon 2020 research and innovation program under grant agreement No 952181 .
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/cerfacs/anubisgit",
"name": "anubisgit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "code metrics, code analysis",
"author": "CoopTeam-CERFACS",
"author_email": "coop@cerfacs.com",
"download_url": "https://files.pythonhosted.org/packages/7d/c6/4ffe1f39e009d121073ed424fcc24f7192e0efc37b62e374b4d9ecb5e9fe/anubisgit-0.7.0.tar.gz",
"platform": null,
"description": "\n\n\n\n# Anubis, a codemetrics tool.\n\nYou can read more about anubisgit on the [internal docummentation page page](http://open-source.pg.cerfacs.fr/anubisgit/).\n\n\n##### Work in progress\n\nToday, Anubis is essentially the script `timemachine.py`.\nthe time machine is a loop can spawn various versions of a code from its gitbase, and perform analysis on it\n\n##### Installation\n\nAnubis I under fast development, and we do not update PiPY very often.\nFor a quick installation in a simplified virtual environment\n\n```bash\npython3 -m venv venv_anubisgit\nsource venv_anubisgit/bin/activate\npython -m pip install 'anubisgit @ git+https://gitlab.com/cerfacs/anubisgit.git'\n```\n\nYou can obiously install it from the sources available on [gitlab.com](https://gitlab.com/cerfacs/anubisgit)\n\n##### main Usage\n\nFor now , there is a minimal CLI, limited to the execution of the time machine of Anubis\nType `>anubisgit` to see what is available :\n\n```bash\n >anubisgit\nUsage: anubisgit [OPTIONS] COMMAND [ARGS]...\n\n Package anubisgit v0.7.0\n\n --------------- Anubis --------------------\n\n You are now using the Command line interface of anubisgit package, a\n set of tools created at CERFACS (https://cerfacs.fr).\n\n This is a python package currently installed in your python\n environement.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n anew Create a default input file in current folder.\n authors-list Retrieve authors list from joined_commits_monthly.json\n branches Analyze branch health\n chronology Code geology\n complexity Analyse code health\n join-db Join Anubis database\n timemachine Build anubisgit database\n```\n\nIf your new to anubisgit, you can find a quick how to tutorial [there](/docs/howto/howto_anubisgit.md)\n\n##### Good practice\n\nAlthought anubisgit timemachine cli command won't let you start a run if your repository is not clean. It is highly recommended to git clone the repository you want to analyze and have a repository for your work repository to avoid any unwanted behaviour or file deletion during the timemachine process.\n\n\n##### Most common troubleshoots\n\n- Unclean repository\n- .gitignore\n \n##### Acknowledgements\n\n\n\nThis work has been initially supported by the [COEC project](https://www.hpccoe.eu/coec/) which has received funding from the European Union\u2019s Horizon 2020 research and innovation program under grant agreement No 952181 .\n",
"bugtrack_url": null,
"license": null,
"summary": "Anubis, a CodeMetrics helper",
"version": "0.7.0",
"project_urls": {
"Bug Tracker": "https://gitlab.com/cerfacs/anubisgit/-/issues",
"Documentation": "https://anubisgit.readthedocs.io/en/latest/",
"Homepage": "https://gitlab.com/cerfacs/anubisgit"
},
"split_keywords": [
"code metrics",
" code analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0235eda6d46ed5b7e39a5db04c8148e563d67d54a2b65feaf31b0b0db34a8c2b",
"md5": "1be8411b3500f48cf595e9c0b3194985",
"sha256": "0f156326e3565926612f890ee6cffc0fa6b243e68601274ee56aaa6cb4fdd4fc"
},
"downloads": -1,
"filename": "anubisgit-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1be8411b3500f48cf595e9c0b3194985",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 60223,
"upload_time": "2024-12-20T14:02:38",
"upload_time_iso_8601": "2024-12-20T14:02:38.278969Z",
"url": "https://files.pythonhosted.org/packages/02/35/eda6d46ed5b7e39a5db04c8148e563d67d54a2b65feaf31b0b0db34a8c2b/anubisgit-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7dc64ffe1f39e009d121073ed424fcc24f7192e0efc37b62e374b4d9ecb5e9fe",
"md5": "48b4e31a739fbe7b45f5c8d366ea7f7e",
"sha256": "be925eee24f20d4a76d2b7de5bad579e196c9c07219b5eb1258c81349e817c41"
},
"downloads": -1,
"filename": "anubisgit-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "48b4e31a739fbe7b45f5c8d366ea7f7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 52122,
"upload_time": "2024-12-20T14:02:41",
"upload_time_iso_8601": "2024-12-20T14:02:41.244057Z",
"url": "https://files.pythonhosted.org/packages/7d/c6/4ffe1f39e009d121073ed424fcc24f7192e0efc37b62e374b4d9ecb5e9fe/anubisgit-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 14:02:41",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "cerfacs",
"gitlab_project": "anubisgit",
"lcname": "anubisgit"
}
JSON