{"id":20509062,"url":"https://github.com/shinesolutions/pythonaem","last_synced_at":"2025-10-29T23:06:54.004Z","repository":{"id":51247995,"uuid":"72181098","full_name":"shinesolutions/pythonaem","owner":"shinesolutions","description":"Python client for Adobe Experience Manager (AEM) API","archived":false,"fork":false,"pushed_at":"2024-05-07T04:40:46.000Z","size":107,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-09-25T02:45:11.131Z","etag":null,"topics":["aem","aem-opencloud","api-client","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shinesolutions.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":"2016-10-28T06:44:47.000Z","updated_at":"2024-07-04T13:49:17.000Z","dependencies_parsed_at":"2024-11-15T20:25:25.071Z","dependency_job_id":"cf91cab5-7823-45c2-be66-137c47e01b3d","html_url":"https://github.com/shinesolutions/pythonaem","commit_stats":{"total_commits":61,"total_committers":2,"mean_commits":30.5,"dds":0.3770491803278688,"last_synced_commit":"94f7b36dee9655b093c5d6fc985322ec265d8203"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/shinesolutions/pythonaem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinesolutions%2Fpythonaem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinesolutions%2Fpythonaem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinesolutions%2Fpythonaem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinesolutions%2Fpythonaem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shinesolutions","download_url":"https://codeload.github.com/shinesolutions/pythonaem/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shinesolutions%2Fpythonaem/sbom","scorecard":{"id":818831,"data":{"date":"2025-08-11","repo":{"name":"github.com/shinesolutions/pythonaem","commit":"4feed9881ad0e02f83889b1b5c3454bccdbf85f5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci-workflow.yaml:1","Info: no jobLevel write permissions found"],"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":"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":"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":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-workflow.yaml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/shinesolutions/pythonaem/ci-workflow.yaml/master?enable=pin","Warn: containerImage not pinned by hash: .github/actions/ci-action/Dockerfile:1: pin your Docker image by updating shinesolutions/aem-platform-buildenv:3.2.0 to shinesolutions/aem-platform-buildenv:3.2.0@sha256:01b7ca625704bdad5b38f5216c5ed555f5c343f2962c747e4dc2fb54efd0e047","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 containerImage 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":"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":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T14:51:57.859Z","repository_id":51247995,"created_at":"2025-08-23T14:51:57.859Z","updated_at":"2025-08-23T14:51:57.859Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281235200,"owners_count":26466153,"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-27T02:00:05.855Z","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":["aem","aem-opencloud","api-client","python"],"created_at":"2024-11-15T20:22:16.767Z","updated_at":"2025-10-29T23:06:53.955Z","avatar_url":"https://github.com/shinesolutions.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/shinesolutions/pythonaem/workflows/CI/badge.svg)](https://github.com/shinesolutions/pythonaem/actions?query=workflow%3ACI)\n[![Published Version](https://badge.fury.io/py/pythonaem.svg)](https://pypi.org/project/pythonaem/)\n[![Vulnerability Scanning Status](https://snyk.io/test/github/shinesolutions/pythonaem/badge.svg)](https://snyk.io/test/github/shinesolutions/pythonaem)\n\nPythonAEM\n---------\n\nPythonAEM is a Python client for [Adobe Experience Manager (AEM)](http://www.adobe.com/au/marketing-cloud/enterprise-content-management.html) API.\nIt is written on top of [swaggeraem](https://github.com/shinesolutions/swagger-aem/blob/master/clients/python/README.md) and provides resource-oriented API and convenient response handling.\n\nLearn more about PythonAEM:\n\n* [Installation](https://github.com/shinesolutions/pythonaem#installation)\n* [Usage](https://github.com/shinesolutions/pythonaem#usage)\n* [Result Model](https://github.com/shinesolutions/pythonaem#result)\n* [Error Handling](https://github.com/shinesolutions/pythonaem#error-handling)\n* [Testing](https://github.com/shinesolutions/pythonaem#testing)\n* [Versions History](https://github.com/shinesolutions/pythonaem/blob/master/docs/versions.md)\n\npythonaem is part of [AEM OpenCloud](https://aemopencloud.io) platform but it can be used as a stand-alone.\n\nInstallation\n------------\n\n    pip3 install pythonaem\n\nUsage\n-----\n\nInitialise client:\n\n    from pythonaem import PythonAem\n\n    conf = {\n        'username': 'admin',\n        'password': 'admin',\n        'protocol': 'http',\n        'host': 'localhost',\n        'port': 4502,\n        'debug': True,\n        'verify_ssl': True,\n        'ssl_ca_cert': None,\n        'cert_file': None,\n        'key_file': None\n    }\n    client = PythonAem(conf)\n\nAem:\n\n    aem = client.aem()\n    result = aem.get_aem_health_check({\n        'tags': 'shallow',\n        'combine_tags_or': 'false',\n    })\n\nFlush agent:\n\n    flush_agent = client.flush_agent('author', 'some-flush-agent')\n\n    # create or update flush agent\n    result = flush_agent.create_update('Some Flush Agent Title', 'Some flush agent description', 'http://somehost:8080')\n\n    # check flush agent's existence\n    result = flush_agent.exists()\n\n    # Disable flush agent\n    result = flush_agent.disable()\n\n    # Enable flush agent\n    result = flush_agent.enable()\n\n    # delete flush agent\n    result = flush_agent.delete()\n\nReplication agent:\n\n    replication_agent = client.replication_agent('author', 'some-replication-agent')\n\n    # create or update replication agent\n    result = replication_agent.create_update('Some Replication Agent Title', 'Some Replication agent description', 'http://somehost:8080')\n\n    # check replication agent's existence\n    result = replication_agent.exists()\n\n    # Disable replication agent\n    result = replication_agent.disable()\n\n    # Enable replication agent\n    result = replication_agent.enable()\n\n    # delete replication agent\n    result = replication_agent.delete()\n\nResult\n------\n\nEach of the above method calls returns a [Result](https://github.com/shinesolutions/pythonaem/blob/master/pythonaem/result.py), which contains message, [Response](https://github.com/shinesolutions/pythonaem/blob/master/pythonaem/response.py), and data payload. For example:\n\n\n    flush_agent = client.flush_agent('author', 'some-inexisting-flush-agent')\n    result = flush_agent.delete()\n    print(result.message)\n    print(result.response.status_code)\n    print(result.response.body)\n    print(result.response.headers)\n    print(result.data)\n\nError Handling\n--------------\n\n    flush_agent = client.flush_agent('author', 'some-inexisting-flush-agent')\n    try:\n        result = flush_agent.delete()\n    except Exception as error:\n        self.assertEqual(error.message, 'Flush agent some-inexisting-flush-agent not found on author')\n\nTesting\n-------\n\nIntegration tests require an AEM instance with [Shine Solutions AEM Health Check](https://github.com/shinesolutions/aem-healthcheck) package installed.\n\nBy default it uses AEM running on http://localhost:4502 with `admin` username and `admin` password. AEM instance parameters can be configured using environment variables `aem_protocol`, `aem_host`, `aem_port`, `aem_username`, and `aem_password`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinesolutions%2Fpythonaem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinesolutions%2Fpythonaem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinesolutions%2Fpythonaem/lists"}