# Plastic SCM Repository Activities Reporting
Python command line library to generate Plastic SCM repository activities reports.
## Usage
### Prerequisite
Our command line utility relies on the following other utilities:
- [`cm`](https://docs.plasticscm.com/cli/plastic-scm-version-control-cli-guide): Plastic SCM command line.
- [`diff`](https://man.cx/diff): Unix utility that computes and displays the differences between the contents of files
- [`diffstat`](https://man.cx/diffstat): Unix utility that provides statistics based on the output of diff.
Make sure that you have configured Plastic SCM client application so that it uses the Unix command-line utility `diff` for comparing text files. This setting needs to be written in the Plastic SCM client application's configuration file `$USER/.plastic4/client.conf`:
```xml
<DiffTools>
<DiffToolData>
<FileType>enTextFile</FileType>
<FileExtensions>*</FileExtensions>
<Tools>
<string>/usr/bin/diff -u "@sourcefile" "@destinationfile"</string>
</Tools>
</DiffToolData>
...
</DiffTools>
```
### Installation
```shell
pip install plasticscm-statistics
```
### Execution
```shell
usage: cmstats [-h] [--end-time ISO8601] [--logging-level LEVEL] [--server NAME] [-o PATH]
[--start-time ISO8601]
Plastic SCM repository activities reporting
options:
-h, --help show this help message and exit
--end-time ISO8601
specify the latest date of changesets to return. This date is exclusive, so changesets that
were made at this date are not returned.
--logging-level LEVEL
specify the logging level (critical, error, warning, info, debug)
--server NAME specify the Plastic SCM server to connect to
-o PATH, --output-file PATH
specify the path and name of the file to write in the activity statistics of the Plastic SCM
repositories
--start-time ISO8601
specify the earliest date of changesets to return. This date is inclusive, so changesets that
were made at this date are returned.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bootloader-studio/cli-plasticscm-statistics.git",
"name": "plasticscm-statistics",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "library,cli,commit,changeset,plasticscm,statistics",
"author": "Daniel CAUNE",
"author_email": "daniel@bootloader.studio",
"download_url": "https://files.pythonhosted.org/packages/63/b4/2005017d999c9b17bf61753b2ca6d0bedc2029853685faaed25bed9fa9c7/plasticscm_statistics-0.0.14.tar.gz",
"platform": null,
"description": "# Plastic SCM Repository Activities Reporting\nPython command line library to generate Plastic SCM repository activities reports.\n\n## Usage\n\n### Prerequisite\nOur command line utility relies on the following other utilities:\n- [`cm`](https://docs.plasticscm.com/cli/plastic-scm-version-control-cli-guide): Plastic SCM command line.\n- [`diff`](https://man.cx/diff): Unix utility that computes and displays the differences between the contents of files\n- [`diffstat`](https://man.cx/diffstat): Unix utility that provides statistics based on the output of diff.\n\nMake sure that you have configured Plastic SCM client application so that it uses the Unix command-line utility `diff` for comparing text files. This setting needs to be written in the Plastic SCM client application's configuration file `$USER/.plastic4/client.conf`:\n\n```xml\n<DiffTools>\n <DiffToolData>\n <FileType>enTextFile</FileType>\n <FileExtensions>*</FileExtensions>\n <Tools>\n <string>/usr/bin/diff -u \"@sourcefile\" \"@destinationfile\"</string>\n </Tools>\n </DiffToolData>\n ...\n</DiffTools>\n```\n\n### Installation\n```shell\npip install plasticscm-statistics\n```\n\n### Execution\n\n```shell\nusage: cmstats [-h] [--end-time ISO8601] [--logging-level LEVEL] [--server NAME] [-o PATH]\n [--start-time ISO8601]\n\nPlastic SCM repository activities reporting\n\noptions:\n -h, --help show this help message and exit\n --end-time ISO8601\n specify the latest date of changesets to return. This date is exclusive, so changesets that\n were made at this date are not returned.\n --logging-level LEVEL\n specify the logging level (critical, error, warning, info, debug)\n --server NAME specify the Plastic SCM server to connect to\n -o PATH, --output-file PATH\n specify the path and name of the file to write in the activity statistics of the Plastic SCM\n repositories\n --start-time ISO8601\n specify the earliest date of changesets to return. This date is inclusive, so changesets that\n were made at this date are returned.\n```",
"bugtrack_url": null,
"license": "SEE LICENSE IN <LICENSE.md>",
"summary": "Python command line library to generate Plastic SCM activities reports",
"version": "0.0.14",
"project_urls": {
"Homepage": "https://github.com/bootloader-studio/cli-plasticscm-statistics.git",
"Repository": "https://github.com/bootloader-studio/cli-plasticscm-statistics.git"
},
"split_keywords": [
"library",
"cli",
"commit",
"changeset",
"plasticscm",
"statistics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0bd9abf8fc3dcd290bf003459fe4400ca6ada1f5d80695065b85f5cae8f66d05",
"md5": "56648820e01c1dd909609be8d7587b27",
"sha256": "a0ca1d2dbf0a17f7367966a2269b5def5e63971a8679c84efcca98bd795f67db"
},
"downloads": -1,
"filename": "plasticscm_statistics-0.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56648820e01c1dd909609be8d7587b27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 14957,
"upload_time": "2023-12-08T13:48:30",
"upload_time_iso_8601": "2023-12-08T13:48:30.663003Z",
"url": "https://files.pythonhosted.org/packages/0b/d9/abf8fc3dcd290bf003459fe4400ca6ada1f5d80695065b85f5cae8f66d05/plasticscm_statistics-0.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63b42005017d999c9b17bf61753b2ca6d0bedc2029853685faaed25bed9fa9c7",
"md5": "2ba098dd9cc18e36778a453dacfe19dc",
"sha256": "72decb65fccf7ea9f9166fdd59dc83783274969799cf7900ab747c99ecfb0628"
},
"downloads": -1,
"filename": "plasticscm_statistics-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "2ba098dd9cc18e36778a453dacfe19dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 10253,
"upload_time": "2023-12-08T13:48:32",
"upload_time_iso_8601": "2023-12-08T13:48:32.016989Z",
"url": "https://files.pythonhosted.org/packages/63/b4/2005017d999c9b17bf61753b2ca6d0bedc2029853685faaed25bed9fa9c7/plasticscm_statistics-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 13:48:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bootloader-studio",
"github_project": "cli-plasticscm-statistics",
"github_not_found": true,
"lcname": "plasticscm-statistics"
}
JSON
