{"id":20526225,"url":"https://github.com/pythoncharmers/tddskeleton","last_synced_at":"2025-10-08T05:22:54.570Z","repository":{"id":136155447,"uuid":"167982303","full_name":"PythonCharmers/TDDskeleton","owner":"PythonCharmers","description":"Quick setup for a TDD exercise using tox","archived":false,"fork":false,"pushed_at":"2019-01-31T02:40:17.000Z","size":20,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-06T01:46:02.290Z","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":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PythonCharmers.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}},"created_at":"2019-01-28T15:09:17.000Z","updated_at":"2019-09-01T22:11:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"511b0508-d96e-43f9-a1f6-4efb9aaf7818","html_url":"https://github.com/PythonCharmers/TDDskeleton","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PythonCharmers/TDDskeleton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PythonCharmers%2FTDDskeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PythonCharmers%2FTDDskeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PythonCharmers%2FTDDskeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PythonCharmers%2FTDDskeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PythonCharmers","download_url":"https://codeload.github.com/PythonCharmers/TDDskeleton/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PythonCharmers%2FTDDskeleton/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263469827,"owners_count":23471614,"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-15T23:13:15.998Z","updated_at":"2025-10-08T05:22:49.545Z","avatar_url":"https://github.com/PythonCharmers.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TDDskeleton\nThe purpose of this is to allow you to quickly get started with test driven development without getting bogged down in setting up a testing pipeile.\n\nThis uses [tox](https://tox.readthedocs.io/en/latest/) to set up a full testing pipeline for the code that is installed via `setup.py` which in this case is the package you can put in the `app/` folder.\n\nAfter you have installed `tox` as per the installation steps below you just have to write your tests in `tests/` and your code in `app/` then run the `tox` command.\n\nDoing this will get you the following testing pipeline run:\n\n- pylint\n- mypy\n- pytest\n- coverage\n\n## Installation\n\nThere's some Python packages that you need to install in order to get started.\n\nThese are found in `test_requirements.txt`, install with:\n\n```bash\npip install -U pip\npip install -r test_requirements.txt\n```\n\n(Updating pip may not be required but is recommended)\n\n## Usage\n\nThere's a folder called `app/` that contains a python package.\n\nYou can write tests for code that resides in `app/` in the `tests/` folder.\n\nTo run the test suite just issue the command `tox` and it will then run the test suite.\n\n### Packages\n\nBecause this is structured in such a way that it installs your code as a package via `setup.py`, you will need to set up any package dependencies your code has in `setup.py`.\n\nGo to `setup.py` and add any packages you depend on into the list for `install_requires`.\n\n## How to setup test-driven development for your own project:\n\n1. Clone https://github.com/PythonCharmers/TDDskeleton\n2. Copy these files to your project folder:\n    - setup.py (and modify it)\n    - tox.ini\n3. Add `tox` to your project's `requirements.txt` file.\n4. pip install -r `requirements.txt`\n5. Change every reference to `app` in `setup.py` and `tox.ini` to your package name.\n6. Update `tox.ini` to refer to the location of your `requirements.txt` if renamed or somewhere else.\n7. Ensure you have a `tests` folder with at least one `test_....py` file.\n\nNow run\n```\ntox\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythoncharmers%2Ftddskeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpythoncharmers%2Ftddskeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpythoncharmers%2Ftddskeleton/lists"}