{"id":17892302,"url":"https://github.com/captainqwerty/pslogwriter","last_synced_at":"2025-04-03T03:40:49.873Z","repository":{"id":259772509,"uuid":"879362181","full_name":"captainqwerty/PSLogWriter","owner":"captainqwerty","description":"PowerShell module to allow easy creation of logs within your PowerShell projects","archived":false,"fork":false,"pushed_at":"2024-10-28T23:46:22.000Z","size":17,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-08T17:41:37.662Z","etag":null,"topics":["log","logging","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/captainqwerty.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-27T17:49:49.000Z","updated_at":"2025-01-20T15:20:11.000Z","dependencies_parsed_at":"2025-02-08T17:41:08.557Z","dependency_job_id":"3905bf7c-be9c-4d83-a513-d25539033be7","html_url":"https://github.com/captainqwerty/PSLogWriter","commit_stats":null,"previous_names":["captainqwerty/pslogwriter"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captainqwerty%2FPSLogWriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captainqwerty%2FPSLogWriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captainqwerty%2FPSLogWriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/captainqwerty%2FPSLogWriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/captainqwerty","download_url":"https://codeload.github.com/captainqwerty/PSLogWriter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933356,"owners_count":20857052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["log","logging","powershell"],"created_at":"2024-10-28T14:35:36.458Z","updated_at":"2025-04-03T03:40:49.856Z","avatar_url":"https://github.com/captainqwerty.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n\u003ch1\u003e\u003cb\u003ePSLogWriter\u003c/b\u003e\u003c/h1\u003e\n  \u003cp\u003e\n    A simple project to easily add a log to your scripts\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/captainqwerty/PSLogWriter/releases\"\u003eReleases\u003c/a\u003e -\n    \u003ca href=\"https://github.com/captainqwerty/PSLogWriter/issues\"\u003eReport Bug\u003c/a\u003e -\n    \u003ca href=\"https://github.com/CaptainQwerty/PSLogWriter/blob/main/CHANGELOG.md\"\u003eChange Log\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nThis project was to just offer people a easy way to quickly add the ability to output a nice, simple log within their own projects. The module can output a log file of a .txt or .log format and utilises three log entry types: Information, Warning and Error.\n\n### Features\n\n * Information, warning and error logging\n * Customisable date format\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Prerequisites\n* PowerShell version 5.0 or greater\n\n### Installation\n\n## Manual Installation\n1. Download the `Source.zip` from the \u003ca href=\"https://github.com/captainqwerty/PSLogWriter/releases\"\u003elatest release\u003c/a\u003e\n2. Extract the zipped folder\n3. Locate your user module path:\n\n```PowerShell\n# This command will list the usable folders\n$env:PSModulePath -split ';'\n```\n4. Copy the `PSLogWriter` folder from within the extracted folder, to your preferred module folder\n5. Verify the installation\n\n## Verification\n```PowerShell\n# Import the module\nImport-Module PSLogWriter\n\n# Check the module version\nGet-Module PSLogWriter\n\n# View available commands\nGet-Command -Module PSLogWriter\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n```PowerShell\n# Importing the module\nImport-Module PSLogWriter\n\n# Creating a log object, you could delcare several different variable\n# names to have multiple logs running for different information\n$Log = New-Log -LogLocation \"$PSScriptLog\\Log.log\"\n\n# Examples of adding log entries\n$Log.AddInfo(\"This message is informational\") # Info entry\n$Log.AddError(\"Oh no. Something went wrong!\") # Error entry\n$Log.AddWarning(\"Calm yourself, this is a warning\") # Warning entry\n$Log.AddCustomEntry(\"BACON\",\"This is a bacon alert!\") # Custom entry\n$Log.AddCustomEntry(\"Bacon\",\"Green\",\"This is a bacon alert!\") # Custom entry with custom colour\n\n# Removing the module\nRemove-Module PSLogWriter\n```\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n\n* [Othneildrew's Best-README-Template](https://github.com/othneildrew/Best-README-Template)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eBack to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/captainqwerty/PSLogWriter.svg?style=for-the-badge\n[contributors-url]: https://github.com/captainqwerty/PSLogWriter/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/captainqwerty/PSLogWriter.svg?style=for-the-badge\n[forks-url]: https://github.com/captainqwerty/PSLogWriter/network/members\n[stars-shield]: https://img.shields.io/github/stars/captainqwerty/PSLogWriter.svg?style=for-the-badge\n[stars-url]: https://github.com/captainqwerty/PSLogWriter/stargazers\n[issues-shield]: https://img.shields.io/github/issues/captainqwerty/PSLogWriter.svg?style=for-the-badge\n[issues-url]: https://github.com/captainqwerty/PSLogWriter/issues\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://www.linkedin.com/in/antonybragg/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaptainqwerty%2Fpslogwriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaptainqwerty%2Fpslogwriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaptainqwerty%2Fpslogwriter/lists"}