{"id":21648682,"url":"https://github.com/shapiromatron/pyscaffold","last_synced_at":"2026-05-19T11:03:07.718Z","repository":{"id":48654632,"uuid":"386345614","full_name":"shapiromatron/pyscaffold","owner":"shapiromatron","description":"An opinionated Python package template","archived":false,"fork":false,"pushed_at":"2025-01-22T03:47:00.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T04:25:48.549Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/shapiromatron.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.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":"2021-07-15T15:51:55.000Z","updated_at":"2025-01-22T03:46:57.000Z","dependencies_parsed_at":"2023-01-22T07:01:27.599Z","dependency_job_id":"a2391846-12e6-493f-aa39-e3b7ae5ffd52","html_url":"https://github.com/shapiromatron/pyscaffold","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shapiromatron%2Fpyscaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shapiromatron%2Fpyscaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shapiromatron%2Fpyscaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shapiromatron%2Fpyscaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shapiromatron","download_url":"https://codeload.github.com/shapiromatron/pyscaffold/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244538311,"owners_count":20468682,"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","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-11-25T06:59:56.415Z","updated_at":"2026-05-19T11:03:02.688Z","avatar_url":"https://github.com/shapiromatron.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pyscaffold\n\nAn opinionated starter template for setting up a python 3.12+ package with a CLI.\n\nNOTE: this project is unrelated to the excellent [PyScaffold](https://pypi.org/project/PyScaffold/) project. This repo will likely not be published to pypi, and handles a much smaller and more narrow use case. Apologies in advance for the confusion in naming.\n\n## Customize for your project...\n\nTo customize for your own package:\n\n1. Search \u0026 replace `pyscaffold` and replace with `yourproject` (or whatever you want to call it).\n    - includes source code, tests, and this readme!\n    - rename the `pyscaffold` project and test folder too\n2. Review pyproject.toml; change `authors`, `classifiers`, `project.urls`, etc.\n3. Follow the \"Developer setup\" section below\n4. Update this readme! Delete this section, edit quickstart guide, etc.\n\nThis is a manual [cookiecutter](https://github.com/cookiecutter/cookiecutter).  This was done intentionally; keeping it a manual job is nice for testing because it makes it easier to ensure that our github actions work as expected.\n\n## Quickstart\n\nMake sure you have python 3.12 available and on your path. Then:\n\n```bash\n# update pip\npython -m pip install -U pip\n\n# if it's local file or a github link...\npip install path/to/pyscaffold-0.0.3-py3-none-any.whl\n# if it's on pypi\npip install pyscaffold\n\n# test our CLI\npyscaffold --help\npyscaffold hello\npyscaffold hello --name Andy\npyscaffold bottles --num 20\n```\n\n## Developer setup\n\nMake sure you have uv available on your path. Then:\n\n```bash\n# clone project\ngit clone git@github.com:shapiromatron/pyscaffold.git\ncd pyscaffold\n\n# create virtual environment and activate\nuv venv --python=3.12 --prompt pyscaffold .venv\nsource venv/bin/activate  # or venv\\Scripts\\activate on windows.\n\n# install packages\nuv pip install -e \".[dev]\"\n\n# test local install\npyscaffold hello\n\n# run assorted commands\npoe --help\npoe test    # run tests\npoe lint    # identify formatting errors\npoe format  # fix formatting errors when possible\npoe build   # build a python wheel\n```\n\nGithub actions are setup to execute whenever code is pushed to check code formatting and successful tests. In addition, when code is pushed to the `main` branch, a wheel artifact is created and stored on github.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshapiromatron%2Fpyscaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshapiromatron%2Fpyscaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshapiromatron%2Fpyscaffold/lists"}