# GSLogger: Greg's Simple Changelog Generator
A Python-based tool for generating changelogs in Markdown format.
created by: [Friar Greg Denyes](https://github.com/friargregarious)
Licensed under: Apache License Version 2.0
Can be found at
PyPi: https://pypi.org/project/GSLogger/0.1.0/
and
Github: https://github.com/friargregarious/glogger
## Features
* Automatically generates changelogs based on user input
* Supports multiple changelog entries
* Uses Markdown formatting for easy readability
## Usage & initialization
To use the changelog generator, simply run the ```chlog.py``` script or run it from the command prompt and follow the prompts.
```cmd
c:\myproject>glog
```
For collecting artifacts and building the changelog.md file, use the ```-c``` flag like so:
```cmd
c:\myproject>glog -c
```
*Note: runing from command prompt will be a future feature once the app packaging/building functionality is complete.*
Newly created changelog artifacts will be stored in ```ch-logs/``` directory as ```ch-logs/<date>.md``` files.
## Configuration
The tool uses a ```chlog.json``` file to store configuration data, including the application title, developer name, and developer link.
On first run, if this file and the configuration are not present, app will automatically begin asking for these details and save them to a newly created file.
*Note: future features includes a re-calibrate command to update and change these settings if user wants to.*
## Output
The generated changelog is stored in a file called ```changelog.md``` in the app's root directory.
## Contributing
If you'd like to contribute to the development of this tool, please fork the repository and submit a pull request with your changes.
Raw data
{
"_id": null,
"home_page": "https://github.com/friargregarious/glogger",
"name": "GSLogger",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": null,
"keywords": "project, changelog, development",
"author": "Friar Gregory Denyes",
"author_email": "greg.denyes@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/71/b7c1e438b59107c30505add289e5c484cb787d4da16d4b18adb812f1c238/gslogger-0.1.1.tar.gz",
"platform": null,
"description": "# GSLogger: Greg's Simple Changelog Generator\r\n\r\nA Python-based tool for generating changelogs in Markdown format.\r\ncreated by: [Friar Greg Denyes](https://github.com/friargregarious)\r\nLicensed under: Apache License Version 2.0\r\nCan be found at\r\nPyPi: https://pypi.org/project/GSLogger/0.1.0/ \r\nand \r\nGithub: https://github.com/friargregarious/glogger\r\n\r\n## Features\r\n\r\n* Automatically generates changelogs based on user input\r\n* Supports multiple changelog entries\r\n* Uses Markdown formatting for easy readability\r\n\r\n## Usage & initialization\r\n\r\nTo use the changelog generator, simply run the ```chlog.py``` script or run it from the command prompt and follow the prompts.\r\n\r\n```cmd\r\nc:\\myproject>glog\r\n```\r\n\r\nFor collecting artifacts and building the changelog.md file, use the ```-c``` flag like so:\r\n\r\n```cmd\r\nc:\\myproject>glog -c\r\n```\r\n\r\n*Note: runing from command prompt will be a future feature once the app packaging/building functionality is complete.*\r\n\r\nNewly created changelog artifacts will be stored in ```ch-logs/``` directory as ```ch-logs/<date>.md``` files.\r\n\r\n## Configuration\r\n\r\nThe tool uses a ```chlog.json``` file to store configuration data, including the application title, developer name, and developer link.\r\n\r\nOn first run, if this file and the configuration are not present, app will automatically begin asking for these details and save them to a newly created file.\r\n\r\n*Note: future features includes a re-calibrate command to update and change these settings if user wants to.*\r\n\r\n## Output\r\n\r\nThe generated changelog is stored in a file called ```changelog.md``` in the app's root directory.\r\n\r\n## Contributing\r\n\r\nIf you'd like to contribute to the development of this tool, please fork the repository and submit a pull request with your changes.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Greg's Simple Changelog Generator",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://github.com/friargregarious/glogger/issues",
"Funding": "https://paypal.me/friargreg?country.x=CA&locale.x=en_US",
"Homepage": "https://github.com/friargregarious/glogger",
"Say Thanks!": "https://mastodon.social/@gregarious",
"Source": "https://github.com/friargregarious/glogger"
},
"split_keywords": [
"project",
" changelog",
" development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "803bf975842bc9ab4ef5c3f9a804f3f1d1ce054b70f73ed8e640a89e483ec229",
"md5": "f9818434f5f11b8ee6c78fdff84552df",
"sha256": "6cc8416c60de30a5a7e84e187ad95a98ee88b7cbc95662072711fe79679edf8a"
},
"downloads": -1,
"filename": "GSLogger-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9818434f5f11b8ee6c78fdff84552df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.10",
"size": 9661,
"upload_time": "2024-09-19T22:19:43",
"upload_time_iso_8601": "2024-09-19T22:19:43.821388Z",
"url": "https://files.pythonhosted.org/packages/80/3b/f975842bc9ab4ef5c3f9a804f3f1d1ce054b70f73ed8e640a89e483ec229/GSLogger-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3871b7c1e438b59107c30505add289e5c484cb787d4da16d4b18adb812f1c238",
"md5": "8949401be269c2048331fd75542f09a4",
"sha256": "0e018ff3647d86a7de342e24a4550315fa99203faf267bbec578b4978200e5b8"
},
"downloads": -1,
"filename": "gslogger-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "8949401be269c2048331fd75542f09a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 9360,
"upload_time": "2024-09-19T22:19:45",
"upload_time_iso_8601": "2024-09-19T22:19:45.229345Z",
"url": "https://files.pythonhosted.org/packages/38/71/b7c1e438b59107c30505add289e5c484cb787d4da16d4b18adb812f1c238/gslogger-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 22:19:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "friargregarious",
"github_project": "glogger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gslogger"
}
JSON
