{"id":18676163,"url":"https://github.com/foospidy/pysigsci","last_synced_at":"2025-04-12T02:12:29.682Z","repository":{"id":52789387,"uuid":"120931983","full_name":"foospidy/pysigsci","owner":"foospidy","description":"Python module for Signal Sciences","archived":false,"fork":false,"pushed_at":"2023-10-26T12:42:12.000Z","size":247,"stargazers_count":3,"open_issues_count":4,"forks_count":13,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-25T21:51:16.001Z","etag":null,"topics":["api","cli","python","rasp","signal-sciences","signal-sciences-api","signalsciences","sigsci","waf"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foospidy.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2018-02-09T16:56:08.000Z","updated_at":"2021-10-09T02:23:26.000Z","dependencies_parsed_at":"2024-11-07T09:32:58.701Z","dependency_job_id":null,"html_url":"https://github.com/foospidy/pysigsci","commit_stats":{"total_commits":272,"total_committers":11,"mean_commits":"24.727272727272727","dds":"0.16176470588235292","last_synced_commit":"308461324af817a7326d70180b7f1972afaeb450"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foospidy%2Fpysigsci","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foospidy%2Fpysigsci/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foospidy%2Fpysigsci/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foospidy%2Fpysigsci/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foospidy","download_url":"https://codeload.github.com/foospidy/pysigsci/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351462,"owners_count":21089271,"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":["api","cli","python","rasp","signal-sciences","signal-sciences-api","signalsciences","sigsci","waf"],"created_at":"2024-11-07T09:27:56.182Z","updated_at":"2025-04-12T02:12:29.651Z","avatar_url":"https://github.com/foospidy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pysigsci\n\n[![Latest Version](https://img.shields.io/pypi/v/pysigsci.svg)](https://pypi.python.org/pypi/pysigsci/)\n![Python 2.7](https://github.com/foospidy/pysigsci/workflows/Python%202/badge.svg)\n![Python 2.7](https://github.com/foospidy/pysigsci/workflows/Python%203/badge.svg)\n![Python 2.7](https://github.com/foospidy/pysigsci/workflows/API%20Tests/badge.svg)\n\nPython module and CLI tool for the [Signal Sciences](https://docs.signalsciences.net/api/) API.\n\n### Installation\n\n`pip install pysigsci`\n\n### CLI Usage\n\n`$ pysigsci --get requests`\n\nTo see all options run: `$ pysigsci --help`\n\n### Module Usage\n\n```\nfrom pysigsci import sigsciapi\nsigsci = sigsciapi.SigSciApi(email=\"myemail\", password=\"mypassword\")\nsigsci.corp = \"mycorp\"\nsigsci.site = \"mysite\"\n\nparams = {\"q\": \"from:-1d tag:XSS\"}\nprint(sigsci.get_requests(parameters=params))\n```\n\nAlso see [example.py](example.py) as a reference.\n\n### CLI Configuration Audit Tool\n\nUse the command `pysigscia` to audit configuration across sites. This provides basic functionality to help ensure your\nconfigurations are consistent.\n\n#### Usage\n\nFirst download all configurations with the following command:\n\n```\n$ pysigscia --get-config\n```\n\nNext, run the command options that suits your needs. When specifying a site name use the \"short name\".\n\nCompare a site to all other sites, for all configurations:\n\n```\n$ pysigscia --compare \u003csite_name\u003e\n```\n\nCompare a site to one other site, for all configurations:\n\n```\n$ pysigscia --compare \u003csite_name\u003e --to \u003csite_name\u003e\n```\n\nCompare a site to all other sites, for a specific configuration:\n\n```\n$ pysigscia --compare \u003csite_name\u003e --configs request_rules\n```\n\nCompare a site to one other site, for a specific configuration:\n\n```\n$ pysigscia --compare \u003csite_name\u003e --to \u003csite_name\u003e --configs redactions\n```\n\nWhen specifying a specific config the following are supported:\n\n- request_rules\n- signal_rules\n- templated_rules\n- advanced_rules\n- redactions\n- custom_signals\n- custom_alerts\n- header_links\n- integrations\n\n#### Output\n\nThe `pysigscia` command outputs to standard out. For large configuration data, it will be best to redirect the output to a text file for review, example: `$ pysigscia --compare \u003csite_name\u003e \u003e $HOME/Desktop/sigsci_config_audit.txt`\n\n## Use Cases\n\n- Command line: https://labs.signalsciences.com/auditing-signal-sciences-configuration\n- Command line: https://labs.signalsciences.com/proactive-update-around-the-health-of-your-signal-sciences-deployment\n- Command line: [Update integrations configuration](https://gist.github.com/foospidy/c93149f206c3bd25a7be8a13152a625c)\n- Command line: [Expire all events](https://gist.github.com/foospidy/576dd824cb2f1026b9515a0969b11d6f)\n- Command line: [Copy custom signal to all sites](https://gist.github.com/foospidy/d4a3c3c248a59eaec328760753784549)\n- Command line: [Copy request rule to all sites](https://gist.github.com/foospidy/6366e2893e3992b0f6052d31f4ac03c1)\n- Command line: [Copy users to all specified sites](https://gist.github.com/foospidy/7b88a1cfed223d4d4caa9f4598d1a405)\n- Module: [Calculate aggregate availability for all sites](https://gist.github.com/foospidy/f02caef7a1d2080e964cad9c7012b9f7)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoospidy%2Fpysigsci","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoospidy%2Fpysigsci","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoospidy%2Fpysigsci/lists"}