| Name | praximous-aegis-cli JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Automate security documentation for your projects |
| upload_time | 2025-08-27 17:30:35 |
| maintainer | None |
| docs_url | None |
| author | JamesTheGiblet |
| requires_python | >=3.8 |
| license | # MIT License
Copyright (c) 2024 JamesTheGiblet
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
security
documentation
automation
cli
devsecops
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Project Aegis CLI
[](https://github.com/JamesTheGiblet/Project-Aegis-CLI/actions/workflows/python-ci.yml)
[](https://badge.fury.io/py/praximous-aegis-cli)
[](https://opensource.org/licenses/MIT)
A simple command-line tool to automate the generation of essential security documentation for your projects.
## The Problem
Every good project needs a `SECURITY.md` file, a `dependabot.yml` config, and basic security guidelines. But let's be honest—it’s a boring, repetitive chore that's easy to forget. So, most projects don't have them until it's too late.
## The Solution
`aegis` is a simple command-line tool that does the grunt work for you. It scans your project, figures out what language you're using, and generates those essential security starter files. It turns a 15-minute chore into a 3-second command.
## Disclaimer: Read This First
Let's be crystal clear: **this tool is a starting point, not a magic bullet.** It generates boilerplate security documentation based on best practices. It is **NOT** a vulnerability scanner, a security audit tool, or a replacement for a real security strategy. You still need to do the hard work of writing secure code and using dedicated security tools.
## Features
* **Language Detection**: Scans your project to figure out what you're building with (currently supports Python and JavaScript).
* **Generates Essential Files**: Automatically creates the following from best-practice templates:
* `.github/dependabot.yml`: A ready-to-use config to keep your dependencies updated via GitHub.
* `security/SECURITY.md`: A solid, customizable policy for how to report vulnerabilities.
* `security/SecureCodingGuide.md`: A language-specific checklist of common-sense security practices.
* **Safe and Customizable**: Use the `--dry-run` flag to preview changes and `--output` to specify a custom directory.
## Installation
Install from PyPI:
```bash
pip install praximous-aegis-cli
```
Or, to contribute, clone the repo and install in editable mode:
```bash
git clone https://github.com/JamesTheGiblet/Project-Aegis-CLI.git
cd Project-Aegis-CLI
pip install -e .[test]
```
## How to Use It
Navigate to your project directory and run the command. `aegis` will detect the language and generate the files.
```bash
aegis /path/to/your/project
```
### Options
* `--output <directory>`: Put the generated `SECURITY.md` and `SecureCodingGuide.md` files somewhere else.
* `--verbose`: See the full scan report as it runs.
* `--dry-run`: See what the tool would do without actually writing any files.
## The Roadmap
*Perfect is the enemy of shipped*, but here's what's next:
* Support for more languages (Java, Go, Rust).
* Optional integration with tools like Snyk or OSV.
* Better dynamic customization of the generated files.
## Want to Go Deeper?
The free tool gets you started with the basics. But if you want to learn about industry-grade security strategies, penetration testing, and building a secure development lifecycle (SDLC), I'm putting together a comprehensive guide. You can find out more at jamesthegiblet.co.uk.
## License
This project is licensed under the MIT License.
---
*Stop neglecting the basics. The code is the proof, and good security docs are part of that proof.*
Raw data
{
"_id": null,
"home_page": null,
"name": "praximous-aegis-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "security, documentation, automation, cli, devsecops",
"author": "JamesTheGiblet",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/61/19/bc368638a32a11e6e836262a732fcd93e3cf0a915a98b5bbb90c55077dde/praximous_aegis_cli-0.1.0.tar.gz",
"platform": null,
"description": "# Project Aegis CLI\r\n\r\n[](https://github.com/JamesTheGiblet/Project-Aegis-CLI/actions/workflows/python-ci.yml)\r\n[](https://badge.fury.io/py/praximous-aegis-cli)\r\n[](https://opensource.org/licenses/MIT)\r\n\r\nA simple command-line tool to automate the generation of essential security documentation for your projects.\r\n\r\n## The Problem\r\n\r\nEvery good project needs a `SECURITY.md` file, a `dependabot.yml` config, and basic security guidelines. But let's be honest\u2014it\u2019s a boring, repetitive chore that's easy to forget. So, most projects don't have them until it's too late.\r\n\r\n## The Solution\r\n\r\n`aegis` is a simple command-line tool that does the grunt work for you. It scans your project, figures out what language you're using, and generates those essential security starter files. It turns a 15-minute chore into a 3-second command.\r\n\r\n## Disclaimer: Read This First\r\n\r\nLet's be crystal clear: **this tool is a starting point, not a magic bullet.** It generates boilerplate security documentation based on best practices. It is **NOT** a vulnerability scanner, a security audit tool, or a replacement for a real security strategy. You still need to do the hard work of writing secure code and using dedicated security tools.\r\n\r\n## Features\r\n\r\n* **Language Detection**: Scans your project to figure out what you're building with (currently supports Python and JavaScript).\r\n* **Generates Essential Files**: Automatically creates the following from best-practice templates:\r\n * `.github/dependabot.yml`: A ready-to-use config to keep your dependencies updated via GitHub.\r\n * `security/SECURITY.md`: A solid, customizable policy for how to report vulnerabilities.\r\n * `security/SecureCodingGuide.md`: A language-specific checklist of common-sense security practices.\r\n* **Safe and Customizable**: Use the `--dry-run` flag to preview changes and `--output` to specify a custom directory.\r\n\r\n## Installation\r\n\r\nInstall from PyPI:\r\n\r\n```bash\r\npip install praximous-aegis-cli\r\n```\r\n\r\nOr, to contribute, clone the repo and install in editable mode:\r\n\r\n```bash\r\ngit clone https://github.com/JamesTheGiblet/Project-Aegis-CLI.git\r\ncd Project-Aegis-CLI\r\npip install -e .[test]\r\n```\r\n\r\n## How to Use It\r\n\r\nNavigate to your project directory and run the command. `aegis` will detect the language and generate the files.\r\n\r\n```bash\r\naegis /path/to/your/project\r\n```\r\n\r\n### Options\r\n\r\n* `--output <directory>`: Put the generated `SECURITY.md` and `SecureCodingGuide.md` files somewhere else.\r\n* `--verbose`: See the full scan report as it runs.\r\n* `--dry-run`: See what the tool would do without actually writing any files.\r\n\r\n## The Roadmap\r\n\r\n*Perfect is the enemy of shipped*, but here's what's next:\r\n\r\n* Support for more languages (Java, Go, Rust).\r\n* Optional integration with tools like Snyk or OSV.\r\n* Better dynamic customization of the generated files.\r\n\r\n## Want to Go Deeper?\r\n\r\nThe free tool gets you started with the basics. But if you want to learn about industry-grade security strategies, penetration testing, and building a secure development lifecycle (SDLC), I'm putting together a comprehensive guide. You can find out more at jamesthegiblet.co.uk.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License.\r\n\r\n---\r\n*Stop neglecting the basics. The code is the proof, and good security docs are part of that proof.*\r\n",
"bugtrack_url": null,
"license": "# MIT License\r\n \r\n Copyright (c) 2024 JamesTheGiblet\r\n \r\n Permission is hereby granted, free of charge, to any person obtaining a copy\r\n of this software and associated documentation files (the \"Software\"), to deal\r\n in the Software without restriction, including without limitation the rights\r\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n copies of the Software, and to permit persons to whom the Software is\r\n furnished to do so, subject to the following conditions:\r\n \r\n The above copyright notice and this permission notice shall be included in all\r\n copies or substantial portions of the Software.\r\n \r\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n SOFTWARE.\r\n ",
"summary": "Automate security documentation for your projects",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/JamesTheGiblet/Project-Aegis-CLI",
"Issues": "https://github.com/JamesTheGiblet/Project-Aegis-CLI/issues",
"Repository": "https://github.com/JamesTheGiblet/Project-Aegis-CLI"
},
"split_keywords": [
"security",
" documentation",
" automation",
" cli",
" devsecops"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "cd7fb7f628e8491b3482091f0fbf30428db0c5aa817c5cd18cb4eb107a1beb59",
"md5": "4bf70a129aca17d74ede72505b4581f5",
"sha256": "eab40bdb95a2d0186022e5558d8268ea43afbf6cf2110c0b9fba9d1d5b380f3b"
},
"downloads": -1,
"filename": "praximous_aegis_cli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bf70a129aca17d74ede72505b4581f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12864,
"upload_time": "2025-08-27T17:30:34",
"upload_time_iso_8601": "2025-08-27T17:30:34.963849Z",
"url": "https://files.pythonhosted.org/packages/cd/7f/b7f628e8491b3482091f0fbf30428db0c5aa817c5cd18cb4eb107a1beb59/praximous_aegis_cli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6119bc368638a32a11e6e836262a732fcd93e3cf0a915a98b5bbb90c55077dde",
"md5": "f9af37efdf99c458840b798a82d1034d",
"sha256": "eecddf11381913c84f85108c0d5311941aced8c791fa96af39cf82ff776b5e7e"
},
"downloads": -1,
"filename": "praximous_aegis_cli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f9af37efdf99c458840b798a82d1034d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12240,
"upload_time": "2025-08-27T17:30:35",
"upload_time_iso_8601": "2025-08-27T17:30:35.988405Z",
"url": "https://files.pythonhosted.org/packages/61/19/bc368638a32a11e6e836262a732fcd93e3cf0a915a98b5bbb90c55077dde/praximous_aegis_cli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 17:30:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JamesTheGiblet",
"github_project": "Project-Aegis-CLI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "praximous-aegis-cli"
}
