{"id":18716393,"url":"https://github.com/novemberfiveco/s3-site-cache-optimizer","last_synced_at":"2025-10-08T17:18:32.469Z","repository":{"id":25794998,"uuid":"29233595","full_name":"novemberfiveco/s3-site-cache-optimizer","owner":"novemberfiveco","description":"Optimize a static website for hosting in S3, by including a fingerprint into all assets' filenames. The optimized website is uploaded into the specified S3 bucket with the right cache headers.","archived":false,"fork":false,"pushed_at":"2019-09-24T09:35:05.000Z","size":26,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-09-13T06:52:23.630Z","etag":null,"topics":["css","fingerprint","python","s3","s3-bucket","s3-buckets","s3-website","static-site","static-website"],"latest_commit_sha":null,"homepage":"https://novemberfive.co","language":"Python","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/novemberfiveco.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}},"created_at":"2015-01-14T07:57:14.000Z","updated_at":"2020-02-17T05:17:57.000Z","dependencies_parsed_at":"2022-08-24T14:14:37.380Z","dependency_job_id":null,"html_url":"https://github.com/novemberfiveco/s3-site-cache-optimizer","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/novemberfiveco/s3-site-cache-optimizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novemberfiveco%2Fs3-site-cache-optimizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novemberfiveco%2Fs3-site-cache-optimizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novemberfiveco%2Fs3-site-cache-optimizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novemberfiveco%2Fs3-site-cache-optimizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/novemberfiveco","download_url":"https://codeload.github.com/novemberfiveco/s3-site-cache-optimizer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/novemberfiveco%2Fs3-site-cache-optimizer/sbom","scorecard":{"id":695653,"data":{"date":"2025-08-11","repo":{"name":"github.com/novemberfiveco/s3-site-cache-optimizer","commit":"401cffd1c8bcd0d2f4793a89ec1c48ccb8721307"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"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":"Code-Review","score":0,"reason":"Found 1/24 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":"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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: MIT License: 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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 10 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-22T03:36:11.631Z","repository_id":25794998,"created_at":"2025-08-22T03:36:11.631Z","updated_at":"2025-08-22T03:36:11.631Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278981540,"owners_count":26079644,"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-08T02:00:06.501Z","response_time":56,"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":["css","fingerprint","python","s3","s3-bucket","s3-buckets","s3-website","static-site","static-website"],"created_at":"2024-11-07T13:12:32.294Z","updated_at":"2025-10-08T17:18:32.426Z","avatar_url":"https://github.com/novemberfiveco.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# s3-site-cache-optimizer\n\nOptimize a static website for hosting in S3, by including a fingerprint into\nall assets' filenames. The optimized website is uploaded into the specified S3\nbucket with the right cache headers.\n\n\n## Installation\n\nYou can install the stable version using the following [pip](https://pip.pypa.io/en/latest/)\ncommand:\n\n\tpip install --upgrade s3-site-cache-optimizer\n\nIf you want to keep up with the latest features, install the development version:\n\n\tpip install --upgrade https://github.com/novemberfiveco/s3-site-cache-optimizer/archive/develop.zip\n\n\n## Operation\n\nThe command line tool executes the following steps:\n\n1. Index the (local) source dir containing the static website, and search for _assets_ and\n_rewritables_.\n2. Calculate a hash from the contents of each _asset_, and rename it with the filehash in the\nfilename.\n3. Search the contents of the _rewritables_ for references to each of the assets, and rewrite\nthe urls if necessary.\n4. (optional) Gzip all text-based files.\n5. (optional) Upload all files to a path in an S3 bucket, and *remove all other files* from that path.\nAssets are given a never-expiring cache header in order to optimize browser and proxy caching.\n\nAll file operations are executed in a (temporary) output directory, the source directory is not\naltered.\n\n_Assets_ and _rewritables_ are recognized based on their file extension. Currently, the following\nfile extensions are considered as _assets_:\n\n- css\n- svg\n- ttf\n- woff\n- woff2\n- otf\n- eot\n- png\n- jpg\n- jpeg\n- gif\n- js\n- xml\n- mp4\n- webm\n- webp\n\n_Rewritables_ are text-based files with one of the following extensions:\n\n- html\n- htm\n- js\n- css\n- xml\n- json\n\nFile a [feature request](https://github.com/novemberfiveco/s3-site-cache-optimizer/issues/new)\nif you want to see other file extensions added.\n\n\n## Usage\n\n\tusage: s3-site-cache-optimizer [-h] [--debug] [--version]\n\t                               [--exclude PATTERN [PATTERN ...]]\n\t                               [-o OUTPUT_DIR]\n\t                               [--access-key AWS_ACCESS_KEY_ID]\n\t                               [--secret-key AWS_SECRET_ACCESS_KEY]\n\t                               [--region REGION]\n\t                               [--gzip]\n\t                               [--prefix PREFIX]\n\t                               [--domains DOMAIN [DOMAIN ...]]\n\t                               [--skip-s3-upload]\n\t                               source_dir destination_bucket\n\n\tpositional arguments:\n\t  source_dir            Local directory containing a static website.\n\t  destination_bucket    S3 bucket name.\n\n\toptional arguments:\n\t  -h, --help            show this help message and exit\n\t  --debug               Enable debug output\n\t  --version             show program's version number and exit\n\t  --exclude PATTERN [PATTERN ...]\n\t                        Exclude files and directories matching these patterns.\n\t  -o OUTPUT_DIR, --output OUTPUT_DIR\n\t                        Output directory in which local files are written.\n\t                        When absent a temporary directory is created and used.\n\t  --access-key AWS_ACCESS_KEY_ID\n\t                        AWS access key. If this field is not specified,\n\t                        credentials from environment or credentials files will\n\t                        be used.\n\t  --secret-key AWS_SECRET_ACCESS_KEY\n\t                        AWS access secret. If this field is not specified,\n\t                        credentials from environment or credentials files will\n\t                        be used.\n\t  --region REGION       AWS region to connect to.\n\t  --gzip                Gzip text-based files.\n\t  --prefix PREFIX       Subdirectory in which files are stored in the bucket.\n\t                        Stored in the root of the bucket by default.\n\t  --domains DOMAIN [DOMAIN ...]\n\t                        Domain names on which the site will be hosted.\n\t  --skip-s3-upload      Skip uploading to S3.\n\n\n### Example\n\n\t$ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --access-key XXXXXNOVEMBERFIVEXXXXX --secret-key XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\t$ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --exclude \".git/*\" \".git*\" --region eu-west-1\n\t$ s3-site-cache-optimizer ~/srv/www.example.com www.example.com --output ~/srv/example-optimized/ --skip-s3-upload\n\t$ s3-site-cache-optimizer ~/srv/www.example.com my_bucket --domains www.example.com example.com --prefix \"user/sites/www.example.com\"\n\n## License\n\nThe s3-site-cache-optimizer is released under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovemberfiveco%2Fs3-site-cache-optimizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnovemberfiveco%2Fs3-site-cache-optimizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnovemberfiveco%2Fs3-site-cache-optimizer/lists"}