{"id":31915482,"url":"https://github.com/stackify/stackify-api-python","last_synced_at":"2025-10-13T19:47:34.919Z","repository":{"id":21945362,"uuid":"25269859","full_name":"stackify/stackify-api-python","owner":"stackify","description":"Stackify API for Python","archived":false,"fork":false,"pushed_at":"2023-05-22T21:55:11.000Z","size":117,"stargazers_count":4,"open_issues_count":2,"forks_count":6,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-09-29T17:23:06.387Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-15T19:25:28.000Z","updated_at":"2022-04-21T12:56:39.000Z","dependencies_parsed_at":"2022-07-27T02:47:28.824Z","dependency_job_id":null,"html_url":"https://github.com/stackify/stackify-api-python","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/stackify/stackify-api-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackify%2Fstackify-api-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackify%2Fstackify-api-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackify%2Fstackify-api-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackify%2Fstackify-api-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackify","download_url":"https://codeload.github.com/stackify/stackify-api-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackify%2Fstackify-api-python/sbom","scorecard":{"id":845414,"data":{"date":"2025-08-11","repo":{"name":"github.com/stackify/stackify-api-python","commit":"0570aea0b562d1acc71c858f2a51eeff75e680ca"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":3,"reason":"Found 7/21 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: pipCommand not pinned by hash: test-docker-execute.sh:20","Warn: pipCommand not pinned by hash: test-docker-execute.sh:22","Warn: pipCommand not pinned by hash: test.sh:35","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":5,"reason":"5 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-8gq9-2x98-w8hf","Warn: Project is vulnerable to: GHSA-8qvm-5x2c-j2w7","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 16 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T21:19:09.333Z","repository_id":21945362,"created_at":"2025-08-23T21:19:09.333Z","updated_at":"2025-08-23T21:19:09.333Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016839,"owners_count":26085889,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-13T19:47:30.474Z","updated_at":"2025-10-13T19:47:34.912Z","avatar_url":"https://github.com/stackify.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Stackify API for Python\n=======================\n\n## Installation\nstackify-python can be installed through pip:\n```bash\n$ pip install -U stackify-api-python\n```\n\n**stackify-python-api** can be installed through pip:\n```bash\n$ pip install stackify-api-python\n```\n\n## Configuration\n\n\n#### Standard API\n```python\nimport stackify\nlogger = stackify.getLogger(application=\"Python Application\", environment=\"Production\", api_key=\"***\")\nlogger.warning('Something happened')\n```\n\n#### Python Logging Integration\n\n```python\nimport logging\nimport stackify\nlogger = logging.getLogger(__name__)\nstackify_handler = stackify.StackifyHandler(application=\"Python Application\", environment=\"Production\", api_key=\"***\")\nlogger.addHandler(stackify_handler)\nlogger.warning('Something happened')\n```\n\n#### Environment Settings\n\n```bash\nexport STACKIFY_APPLICATION=Python Application\nexport STACKIFY_ENVIRONMENT=Production\nexport STACKIFY_API_KEY=******\n```\n\n\n## Usage\n\n**stackify-python-api** handles uploads in batches of 100 messages at a time on another thread.\nWhen your program exits, it will shut the thread down and upload the remaining messages.\n\nStackify can store extra data along with your log message:\n```python\ntry:\n    user_string = raw_input(\"Enter a number: \")\n    print(\"You entered\", int(user_string))\nexcept ValueError:\n    logger.exception('Bad input', extra={'user entered': user_string})\n```\n\nYou can also name your logger instead of using the automatically generated one:\n```python\nimport stackify\nlogger = stackify.getLogger('mymodule.myfile')\n```\n\n## Internal Logger\n\nThis library has an internal logger it uses for debugging and messaging.\nFor example, if you want to enable debug messages:\n```python\nimport logging\nlogger = logging.getLogger('stackify')\nlogger.setLevel(logging.DEBUG)\nlogger.addHandler(logging.FileHandler('stackify.log'))  # or any handler you want\n```\n\nBy default, it will enable the default logging settings via `logging.basicConfig()`\nand print `WARNING` level messages and above. If you wish to set everything up yourself,\njust pass `basic_config=False` in `getLogger`:\n```python\nimport stackify\n\nlogger = stackify.getLogger(basic_config=False)\n```\n\n## Django Logging Integration\n\nYou can also use your existing django logging and just append stackify logging handler\n\n```python\nLOGGING = {\n    'version': 1,\n    'disable_existing_loggers': False,\n    'handlers': {\n        'file': {\n            'level': 'DEBUG',\n            'class': 'logging.FileHandler',\n            'filename': 'debug.log',\n        },\n        'stackify': {\n            'level': 'DEBUG',\n            'class': 'stackify.StackifyHandler',\n            'application': 'MyApp',\n            'environment': 'Dev',\n            'api_key': '******',\n        }\n    },\n    'loggers': {\n        'django': {\n            'handlers': ['file', 'stackify'],\n            'level': 'DEBUG',\n            'propagate': True,\n        },\n    },\n}\n```\n\nUsage\n```python\nimport logging\n\nlogger = logging.getLogger('django')\n\n\nlogger.warning('Something happened')\n```\n\n\n## **Real User Monitoring (RUM)**\n\nReal user monitoring injects a script tag containing the [RUM JS](https://stackify.com/retrace-real-user-monitoring/) that is responsible for capturing information about the http requests on the browser. This approach is manual and needs to be configured.\n\n### RUM - Setup\n\n```python\n# Configuration - Standard API\nlogger = stackify.getLogger(..., rum_key=\"YourRumKey\")\n# or Configuration - Python Logging Integration\nstackify.StackifyHandler(..., rum_key=\"YourRumKey\")\n\n# Use this to apply on views\nimport stackify.rum\n\nstackify.rum.insert_rum_script()\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackify%2Fstackify-api-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackify%2Fstackify-api-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackify%2Fstackify-api-python/lists"}