{"id":24184517,"url":"https://github.com/29next/theme-kit","last_synced_at":"2025-09-21T07:30:54.341Z","repository":{"id":38241873,"uuid":"369390340","full_name":"29next/theme-kit","owner":"29next","description":"Local development tool for storefront theme developers to sync templates and assets to stores on the 29 Next ecommerce platform.","archived":false,"fork":false,"pushed_at":"2025-06-30T01:56:03.000Z","size":7841,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-28T22:05:49.115Z","etag":null,"topics":["ecommerce","sass","storefront-theme","theme-kit","themes"],"latest_commit_sha":null,"homepage":"https://developers.29next.com","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/29next.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,"zenodo":null}},"created_at":"2021-05-21T02:20:04.000Z","updated_at":"2025-06-30T01:56:07.000Z","dependencies_parsed_at":"2024-03-22T10:30:07.305Z","dependency_job_id":"ff676a70-0cd3-4b6b-8611-cda950d960f9","html_url":"https://github.com/29next/theme-kit","commit_stats":{"total_commits":224,"total_committers":9,"mean_commits":24.88888888888889,"dds":0.4955357142857143,"last_synced_commit":"39529f5e7aded84a80751f2aef5cb20a23bd8b9c"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/29next/theme-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/29next%2Ftheme-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/29next%2Ftheme-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/29next%2Ftheme-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/29next%2Ftheme-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/29next","download_url":"https://codeload.github.com/29next/theme-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/29next%2Ftheme-kit/sbom","scorecard":{"id":2836,"data":{"date":"2025-08-11","repo":{"name":"github.com/29next/theme-kit","commit":"f8d04e8624890777ebc4f07fbc31b4bbe6e0ac46"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.1,"checks":[{"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":"Maintained","score":0,"reason":"1 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":1,"reason":"Found 2/14 approved changesets -- score normalized to 1","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":9,"reason":"binaries present in source code","details":["Warn: binary detected: windows/ntk.exe:1"],"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml: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":"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":"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/release.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/test.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/29next/theme-kit/test.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:20","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:15","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:16","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:36","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:37","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:38","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   6 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":"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":"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":"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:6"],"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":"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":-1,"reason":"internal error: internal error: Client.Checks.ListCheckRunsForRef: error during graphqlHandler.setupCheckRuns: non-200 OK status code: 502 Bad Gateway body: \"\u003chtml\u003e\\r\\n\u003chead\u003e\u003ctitle\u003e502 Bad Gateway\u003c/title\u003e\u003c/head\u003e\\r\\n\u003cbody\u003e\\r\\n\u003ccenter\u003e\u003ch1\u003e502 Bad Gateway\u003c/h1\u003e\u003c/center\u003e\\r\\n\u003chr\u003e\u003ccenter\u003enginx\u003c/center\u003e\\r\\n\u003c/body\u003e\\r\\n\u003c/html\u003e\\r\\n\"","details":null,"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-14T12:56:12.559Z","repository_id":38241873,"created_at":"2025-08-14T12:56:12.559Z","updated_at":"2025-08-14T12:56:12.559Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273907740,"owners_count":25188997,"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-09-06T02:00:13.247Z","response_time":2576,"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":["ecommerce","sass","storefront-theme","theme-kit","themes"],"created_at":"2025-01-13T10:15:31.039Z","updated_at":"2025-09-21T07:30:54.335Z","avatar_url":"https://github.com/29next.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Badges --\u003e\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![CodeCov][codecov-image]][codecov-link]\n\n# 29 Next Theme Kit\n\nTheme Kit is a cross-platform command line tool to build and maintain storefront themes with [Sass Processing](#sass-processing) support on the 29 Next platform.\n\n## Installation\n\nTheme Kit is a python package available on [PyPi](https://pypi.org/project/next-theme-kit/)\n\nIf you already have `python` and `pip`, install with the following command:\n\n```\npython -m pip install next-theme-kit\n```\n\n#### Mac OSX Requirements\nSee how to install `python` and `pip` with [HomeBrew](https://docs.brew.sh/Homebrew-and-Python#python-3x). Once you have completed this step you can install using the `pip` instructions above.\n\n#### Windows Requirements\n\n* **Option 1 (Recommended)** - Windows 10 and above feature WSL (Windows Subsystem for Linux) which provides a native Linux environment, see how to [Install WSL with Ubuntu](https://docs.microsoft.com/en-us/windows/wsl/install). Once you have installed WSL, follow the [best practice guides to configure and use with VS Code](https://docs.microsoft.com/en-us/windows/wsl/setup/environment) and then follow the `pip` instructions above to install Theme Kit.\n\n* **Option 2** - Installing `python` in Windows natively can be done with through the [Windows App Store](https://apps.microsoft.com/store/detail/python-39/9P7QFQMJRFP7?hl=en-us\u0026gl=us). Recommend using [Windows Powershell](https://apps.microsoft.com/store/detail/powershell/9MZ1SNWT0N5D?hl=en-us\u0026gl=us). This route is a little more tricky and some knowledge on how to manage python in windows will be required.\n\n\u003e **Use Python Virtual Environments** - For Mac, Windows, and Linux, it's a best practice to use a Python Virtual Environment to isolate python packages and dependecies to reduce potential conflicts or errors, [more on creating a Python Virutal Environment](https://www.freecodecamp.org/news/how-to-setup-virtual-environments-in-python/).\n\n\n#### Updating Theme Kit\n\nUpdate to the latest version of Theme Kit with the following command:\n```\npython -m pip install next-theme-kit --upgrade\n```\n\n\u003e :warning: **Important**\n\u003e\n\u003e As of version 1.0.2, the store authentication uses Oauth and requires creating a store **Oauth App** with `themes:read` and `themes:write` permissions.\n\n## Usage\nWith the package installed, you can now use the commands inside your theme directory and work on a storefront theme.\n\n**Available Commands**\n* `ntk init` - initialize a new theme\n* `ntk list` - list all available themes\n* `ntk checkout` - checkout an existing theme\n* `ntk pull` - download existing theme or theme file\n* `ntk push` - push current theme state to store\n* `ntk watch` - watch for local changes and automatically push changes to store\n* `ntk sass` - process sass to css, see [Sass Processing](#sass-processing)\n\n**Important** - You must pass the `apikey` and `store` parameters for all commands **if** there is not an existing `config.yml` file in your current directory.\n\n#### Init\nInitialize a new theme which will create the theme on a store and create an initial config.yml file\n\n```\nntk init --name=\"\u003cTheme Name\u003e\" --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n| -n | --name | Name of the new theme |\n\n\n#### List\nList all themes installed on the theme.\n```\nntk list --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n\n\n#### Checkout\nCheckout a theme from your store to pull it into your directory.\n```\nntk checkout --theme_id=\u003cid\u003e --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n| -t | --theme_id | ID of the theme. |\n\n#### Pull\nPull a theme from your store to into your directory.\n```\nntk pull --theme_id=\u003cid\u003e --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n| -t | --theme_id | ID of the theme. |\n\n\n#### Push\nPush all theme files from your local directory to the store.\n```\nntk push --theme_id=\u003cid\u003e --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n| -t | --theme_id | ID of the theme. |\n\n\n#### Watch\nWatch for file changes and additions in your local directory and automatically push them to the store.\n```\nntk watch --theme_id=\u003cid\u003e --apikey=\"\u003capi key\u003e\" --store=\"\u003chttps://storedomain.com\u003e\"\n```\n##### Required flags without config.yml\n| Short | Long | Description|\n|--- | --- | --- |\n| -a | --apikey | API Key used to connect to the store.|\n| -s | --store | Full domain of the store. |\n| -t | --theme_id | ID of the theme. |\n\n#### Sass\nProcess `sass` files to CSS files for inclusion in your storefront. See [Sass Processing](#sass-processing) for more details.\n\n```\nntk sass\n```\n##### Optional flags\n| Short | Long | Description|\n|--- | --- | --- |\n| -sos | --sass_output_style |  Options are nested, expanded, compact, or compressed|\n\n\n\n## Sass Processing\nTheme kit includes support for Sass processing via [Python Libsass](https://sass.github.io/libsass-python/). Sass processing includes support for variables, imports, nesting, mixins, inheritance, custom functions, and more.\n\n**How it works**\n1. Put `scss` files in top level `sass` directory.\n2. Run `ntk sass` or `ntk watch` to process theme `sass` files.\n3. Top level `scss` files will be processed to `css` files in the asset directory with the same name.\n\n**Example Theme with Sass Structure**\n```\n├── assets\n│   ├── styles.css // reference this asset file in templates\n├── sass\n│   ├── _base.scss\n│   ├── _variables.scss\n│   └── styles.scss // processed to assets/main.css\n```\n\n**Important** - Sass processing is only supported on local, files in the `sass` directory are uploaded to your store for storage but cannot be edited in the store theme editor.\n\n**Configure Default Output Style**\n\nChange the default sass output style in `config.yml`, example below.\n\n```\ndevelopment:\n  apikey: \u003capi key\u003e\n  sass:\n    output_style: compressed // options: nested, expanded, compact, or compressed\n  store: \u003cstore url\u003e\n  theme_id: \u003ctheme id\u003e\n```\n\n\n\u003c!-- Badges --\u003e\n[codecov-image]: https://codecov.io/gh/29next/theme-kit/branch/master/graph/badge.svg?token=LPUOTZ5MZ5\n[codecov-link]: https://codecov.io/gh/29next/theme-kit\n[pypi-v-image]: https://img.shields.io/pypi/v/next-theme-kit.svg\n[pypi-v-link]: https://pypi.org/project/next-theme-kit/\n[GHAction-image]: https://github.com/29next/theme-kit/actions/workflows/test.yml/badge.svg?branch=master\n[GHAction-link]: https://github.com/29next/theme-kit/actions?query=event%3Apush+branch%3Amaster\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F29next%2Ftheme-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F29next%2Ftheme-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F29next%2Ftheme-kit/lists"}