{"id":20319217,"url":"https://github.com/syntaxrules/python-starter","last_synced_at":"2025-04-11T18:12:58.169Z","repository":{"id":73412931,"uuid":"88206096","full_name":"SyntaxRules/python-starter","owner":"SyntaxRules","description":"A starting spot for python projects. Embracing open source elements.","archived":false,"fork":false,"pushed_at":"2017-05-26T18:17:42.000Z","size":20,"stargazers_count":5,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T18:12:45.491Z","etag":null,"topics":["automation","open-source","python","starter-template"],"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/SyntaxRules.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":"2017-04-13T21:00:23.000Z","updated_at":"2021-04-09T15:35:32.000Z","dependencies_parsed_at":"2023-02-28T00:16:24.378Z","dependency_job_id":null,"html_url":"https://github.com/SyntaxRules/python-starter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyntaxRules%2Fpython-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyntaxRules%2Fpython-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyntaxRules%2Fpython-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SyntaxRules%2Fpython-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SyntaxRules","download_url":"https://codeload.github.com/SyntaxRules/python-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456372,"owners_count":21106604,"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":["automation","open-source","python","starter-template"],"created_at":"2024-11-14T18:45:37.410Z","updated_at":"2025-04-11T18:12:58.160Z","avatar_url":"https://github.com/SyntaxRules.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-starter\nA starting spot for python projects. Embracing open source elements.\n\n[![Documentation status](https://readthedocs.org/projects/python-starter/badge/?version=latest)](http://python-starter.readthedocs.io/en/latest/) [![Build Status](https://travis-ci.org/SyntaxRules/python-starter.svg?branch=master)](https://travis-ci.org/SyntaxRules/python-starter) [![codecov](https://codecov.io/gh/SyntaxRules/python-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/SyntaxRules/python-starter)\n\nDocumentation: http://python-starter.readthedocs.io/en/latest/\n\n# Project Details\n\n## Structure\n\nThis project follows the structure suggested in [Jan-Philip Gehrcke's Blog](https://gehrcke.de/2014/02/distributing-a-python-command-line-application/).\n\n## Versioning\n\nThis project uses [Semver](http://semver.org/) as its versioning scheme.\n\n## Tests\n\nBasic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`. The unit tests are in line with the code. You can run all the tests with `python -m pytest .`.\n\nThe tests are ran automatically when they are submitted to github via [travici.org](https://travis-ci.org/SyntaxRules/python-starter). Your tests must work here to be considered passing, it doesn't matter if they run on your local machine, if they fail on TravisCI, then they will not be accepted into matser.\n\nCoverage is also determined by TravisCI and reported to [CodeCov](https://codecov.io/gh/SyntaxRules/python-starter).\n\n## Documentation\n\nDocumentation is inline (like unit tests) and deployed with [Read the Docs](http://python-starter.readthedocs.io/en/latest/). When editing code, please include documentation for your changes. Add any new files to the `mkdocs.yml` file. The documentation is automatically built and installed.\n\nThe documentation is found here: http://python-starter.readthedocs.io/en/latest/\n\nYou can test the docs locally by installing [mkdocs](http://www.mkdocs.org/) and running `mkdocs serve` in the root directory of the project source. This will launch a server locally that you can use to view what the docs will look like when deployed. The pages update automatically when changes are made.\n\nYou can add a page to the documentation by editing the *mkdocs.yml* file in the source repo. See [Adding Pages](http://www.mkdocs.org/#adding-pages).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntaxrules%2Fpython-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyntaxrules%2Fpython-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyntaxrules%2Fpython-starter/lists"}