# tacitus-notes
[Publius Cornelius Tacitus](https://en.wikipedia.org/wiki/Tacitus) was a Roman
historian and politician. And quite recently, he started writing notes on our git
repositories.
## the dream
Walk through git log, up to last tag or target commit, and collect each commit
message in a markdown format:
- prettify it,
- *replace ticket numbers with urls*
- print on console
## shellscript version
```bash
git describe --tags --abbrev=0
git log $(git describe --tags --abbrev=0)..HEAD --oneline
```
## python version
First, install the tiny script:
```bash
$ pip install tacitus-notes
```
Then, run this command in your project directory and see what happens:
```bash
$ tacitus-notes
```
You can use `--first` and `--last` arguments to define ranges
```bash
$ tacitus-notes --first=<commit_hash> --last=<commit_hash>
```
BSD 2-Clause License
Copyright (c) 2021, Florin Ciurcanu
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://github.com/kopsha/tacitus-notes",
"name": "tacitus-notes",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "automatic release notes,release notes,markdown,git scraping",
"author": "Florin Ciurcanu",
"author_email": "florin.ciurcanu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/82/10640337d405d05c05414ac632e8697c0c3f8af1b3dd2b4d4a73031533cd/tacitus_notes-0.3.1.tar.gz",
"platform": null,
"description": "# tacitus-notes\n\n[Publius Cornelius Tacitus](https://en.wikipedia.org/wiki/Tacitus) was a Roman\nhistorian and politician. And quite recently, he started writing notes on our git\nrepositories.\n\n\n## the dream\n\nWalk through git log, up to last tag or target commit, and collect each commit\nmessage in a markdown format:\n- prettify it,\n- *replace ticket numbers with urls*\n- print on console\n\n## shellscript version\n\n```bash\ngit describe --tags --abbrev=0\ngit log $(git describe --tags --abbrev=0)..HEAD --oneline\n```\n\n\n## python version\n\nFirst, install the tiny script:\n\n```bash\n$ pip install tacitus-notes\n```\n\nThen, run this command in your project directory and see what happens:\n\n```bash\n$ tacitus-notes\n```\n\nYou can use `--first` and `--last` arguments to define ranges\n```bash\n$ tacitus-notes --first=<commit_hash> --last=<commit_hash>\n```\n\nBSD 2-Clause License\n\nCopyright (c) 2021, Florin Ciurcanu\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License",
"summary": "Generate release notes from git history, using markdown syntax.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/kopsha/tacitus-notes"
},
"split_keywords": [
"automatic release notes",
"release notes",
"markdown",
"git scraping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "935d4ccbd6111471f1b164b321b79e208892086c9dd505f3c83b0b8a35615bd5",
"md5": "1a6e695842db718c9b60ab0594357616",
"sha256": "3315cdaf12be5dd58f3324302eaac534ead2e45232603b9057038def9d41b054"
},
"downloads": -1,
"filename": "tacitus_notes-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a6e695842db718c9b60ab0594357616",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5902,
"upload_time": "2023-11-09T09:48:40",
"upload_time_iso_8601": "2023-11-09T09:48:40.695088Z",
"url": "https://files.pythonhosted.org/packages/93/5d/4ccbd6111471f1b164b321b79e208892086c9dd505f3c83b0b8a35615bd5/tacitus_notes-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee8210640337d405d05c05414ac632e8697c0c3f8af1b3dd2b4d4a73031533cd",
"md5": "a4ee1cefb6c171764c36d107eefa01ae",
"sha256": "f953d5ac4a9a9b7d78c7c37329fbf37a1559801cd71dd8f86902f5246868cfd8"
},
"downloads": -1,
"filename": "tacitus_notes-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "a4ee1cefb6c171764c36d107eefa01ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4639,
"upload_time": "2023-11-09T09:48:42",
"upload_time_iso_8601": "2023-11-09T09:48:42.237189Z",
"url": "https://files.pythonhosted.org/packages/ee/82/10640337d405d05c05414ac632e8697c0c3f8af1b3dd2b4d4a73031533cd/tacitus_notes-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-09 09:48:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kopsha",
"github_project": "tacitus-notes",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tacitus-notes"
}
JSON
