{"id":16959502,"url":"https://github.com/crdoconnor/projectkey","last_synced_at":"2026-05-03T20:39:42.819Z","repository":{"id":19480158,"uuid":"22725778","full_name":"crdoconnor/projectkey","owner":"crdoconnor","description":"A development tool for running a suite of custom project commands with one key.","archived":false,"fork":false,"pushed_at":"2015-06-29T13:48:33.000Z","size":308,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-24T05:09:53.430Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crdoconnor.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-07T15:12:14.000Z","updated_at":"2017-02-16T07:14:12.000Z","dependencies_parsed_at":"2022-09-14T13:31:36.367Z","dependency_job_id":null,"html_url":"https://github.com/crdoconnor/projectkey","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crdoconnor/projectkey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crdoconnor%2Fprojectkey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crdoconnor%2Fprojectkey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crdoconnor%2Fprojectkey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crdoconnor%2Fprojectkey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crdoconnor","download_url":"https://codeload.github.com/crdoconnor/projectkey/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crdoconnor%2Fprojectkey/sbom","scorecard":{"id":307911,"data":{"date":"2025-08-11","repo":{"name":"github.com/crdoconnor/projectkey","commit":"0b607a3bde5129e341b30f0316b0e539838c825d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":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":"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":"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":"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":"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":"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":"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":"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":"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.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt: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"}}]},"last_synced_at":"2025-08-17T22:32:28.753Z","repository_id":19480158,"created_at":"2025-08-17T22:32:28.753Z","updated_at":"2025-08-17T22:32:28.753Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32584645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-10-13T22:45:08.304Z","updated_at":"2026-05-03T20:39:42.800Z","avatar_url":"https://github.com/crdoconnor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"ProjectKey\n==========\n\nProjectKey is a framework to let you write a self-documenting suite of commands in\npython to automate common project tasks.\n\nYou can then run these commands from any folder inside your project by using the 'k'\nkey.\n\nFor example::\n\n    $ k help\n    Usage: k command [args]\n\n    Yourproject development environment commands.\n\n                    runserver - Run django debug web server on port 8000\n                        shell - Run django shell.\n                      upgrade - pip upgrade on all packages and freeze to requirements afterwards.\n                         smtp - Run development smtp server on port 25025.\n      striptrailingwhitespace - strip the trailing whitespace from all files in your mercurial repo.\n                  inspectfile - Inspect file(s) for pylint violations.\n\n    Run 'k help [command]' to get more help on a particular command.\n\n\nThree Step Quickstart\n=====================\n\nStep 1: Install like so::\n\n    $ sudo pip install projectkey\n\nStep 2: Create a key.py file in the root folder of your project like this:\n\n.. code-block:: python\n\n    #!/usr/bin/python\n    \"\"\"Yourproject development environment commands.\"\"\"\n    from projectkey import cd, run, run_return, runnable, ignore_ctrlc\n\n    def runserver():\n        \"\"\"Run django debug web server on port 8080.\"\"\"\n        print \"Running webserver...\"\n        # Run simple shell commands, assuming you are in the same directory as your key.py file.\n        run(\"./venv/bin/python manage.py runserver_plus 8080 --traceback --settings=yourproject.special_settings\")\n\n    @ignore_ctrlc       # Projectkey will ignore the user pressing ctrl-C when running this command\n    def shell():\n        \"\"\"Run django shell.\"\"\"\n        print \"Running shell...\"\n        # ...since you want the python shell to decide what to do with Ctrl-C.\n        run(\"./venv/bin/python manage.py shell --settings=yourproject.special_settings\")\n\n    def upgrade():\n        \"\"\"pip upgrade on all packages and freeze to requirements afterwards.\"\"\"\n        # Copy and paste in whole bash scripts if you like...\n        run(\"\"\"\n            ./venv/bin/pip freeze --local | grep -v '^\\-e' | cut -d = -f 1  | xargs ./venv/bin/pip install -U\n            ./venv/bin/pip freeze \u003e ./requirements.txt\n        \"\"\")\n\n    def smtp():\n        \"\"\"Run development smtp server on port 25025.\"\"\"\n        print \"Running SMTP server...\"\n        run(\"python -m smtpd -n -c DebuggingServer localhost:25025\")\n\n    def striptrailingwhitespace():\n        \"\"\"strip the trailing whitespace from all files in your mercurial repo.\"\"\"\n        # Get the output of shell commands...\n        repofiles = run_return(\"hg locate *.py\").split('\\n')\n\n        # ...and write simple, short, python scripts to do stuff with it.\n        repofiles.remove('')\n        for filename in repofiles:\n            with open(filename, 'r') as fh:\n                new = [line.rstrip() for line in fh]\n            with open(filename, 'w') as fh:\n                [fh.write('%s\\n' % line) for line in new]\n\n    def inspectfile(*filenames):\n        \"\"\"Inspect file(s) for pylint violations.\"\"\"\n        # You can also change to the directory that the k command was run from, if you need that.\n        cd(CWD)\n        run(\"{0}/venv/bin/pylint --rcfile={0}/pylintrc -r n {1}\".format(KEYDIR, ' '.join(filenames)))\n\n    # Add this and you can run the file directly (e.g. python key.py smtp) as well as by running \"k smtp\".\n    runnable(__name__)\n\nStep 3: Run the 'k' command in any folder in your project::\n\n    $ k inspectfile onefile.py twofiles.py\n    [ Runs pylint on those files ]\n\nStep 4: Add more commands.\n\n\nFeatures\n========\n\n* Autodocuments using your docstrings.\n* Use variables KEYDIR or CWD in any command to refer to key.py's directory or the directory you ran k in.\n* Passes any arguments on to the method via the command line (optional arguments and variable numbers of arguments can be used too).\n* Autocomplete works out of the box.\n* Comes with shortcut command 'run' to run lists of shell commands directly, so you can copy and paste directly from existing shell scripts.\n* Selectively ignore Ctrl-C (by default it tries to stop and exit).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrdoconnor%2Fprojectkey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrdoconnor%2Fprojectkey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrdoconnor%2Fprojectkey/lists"}