{"id":16110248,"url":"https://github.com/franneck94/pythonprojecttemplate","last_synced_at":"2025-03-16T08:32:38.405Z","repository":{"id":114410021,"uuid":"278835292","full_name":"franneck94/PythonProjectTemplate","owner":"franneck94","description":"Python project template with unit-tests, documentation, ci-testing and workflows.","archived":false,"fork":false,"pushed_at":"2024-04-22T05:31:40.000Z","size":652,"stargazers_count":63,"open_issues_count":1,"forks_count":55,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-16T00:23:02.661Z","etag":null,"topics":["benchmark","codecov","conda","github-actions","makefile","pre-commit","pytest","python","setuptools","sphinx","testing","travis-ci","vscode","workflows"],"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/franneck94.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}},"created_at":"2020-07-11T10:03:53.000Z","updated_at":"2025-03-11T13:36:49.000Z","dependencies_parsed_at":"2024-04-22T06:45:41.830Z","dependency_job_id":null,"html_url":"https://github.com/franneck94/PythonProjectTemplate","commit_stats":null,"previous_names":["franneck94/pythonprojecttemplate"],"tags_count":10,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/franneck94%2FPythonProjectTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/franneck94%2FPythonProjectTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/franneck94%2FPythonProjectTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/franneck94%2FPythonProjectTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/franneck94","download_url":"https://codeload.github.com/franneck94/PythonProjectTemplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243846982,"owners_count":20357295,"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":["benchmark","codecov","conda","github-actions","makefile","pre-commit","pytest","python","setuptools","sphinx","testing","travis-ci","vscode","workflows"],"created_at":"2024-10-09T19:36:34.148Z","updated_at":"2025-03-16T08:32:38.026Z","avatar_url":"https://github.com/franneck94.png","language":"Python","readme":"# FastVector\n\n![Python](https://img.shields.io/badge/python-3.9+-blue)\n![License](https://camo.githubusercontent.com/890acbdcb87868b382af9a4b1fac507b9659d9bf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)\n[![Build](https://github.com/franneck94/Python-Project-Template/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/franneck94/Python-Project-Template/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/franneck94/Python-Project-Template-Eng/branch/master/graph/badge.svg)](https://codecov.io/gh/franneck94/Python-Project-Template-Eng)\n[![Documentation](https://img.shields.io/badge/ref-Documentation-blue)](https://franneck94.github.io/Python-Project-Template-Eng/)\n\n## Template For Python Projects\n\nThis is a template for Python projects. What you get:\n\n- Source code and test code is seperated in different directories.\n- External libraries installed and managed by [Pip](https://pypi.org/project/pip/) and [setuptools](https://setuptools.pypa.io/en/latest/) in a pyproject.toml.\n- Setup for tests using [Pytest](https://docs.pytest.org/en/stable/) and coverage with [Pytest-Cov](https://github.com/pytest-dev/pytest-cov).\n- Continuous testing with [Github-Actions](https://github.com/features/actions/) including [pre-commit](https://github.com/pre-commit/pre-commit).\n- Code coverage reports, including automatic upload to [Codecov](https://codecov.io).\n- Code documentation with [Mkdocs](https://www.mkdocs.org/).\n\n## Structure\n\n``` text\n├── pyproject.toml\n├── ... other config files ...\n├── docs\n│   ├── api.md\n│   └── index.md\n├── examples\n│   └── ...\n├── fastvector\n│   ├── __init__.py\n│   ├── vector.py\n│   └── version.py\n└── tests\n    ├── __init__.py\n    └── test_vector.py\n```\n\n### Commands\n\n```bash\n# Build and Install (local)\npip install -e .  # OR\npip install -e ../Python-Project-Template  # OR\npip install -e ../Python-Project-Template[all]\n```\n\n```bash\n# Test\npytest tests  # OR\npytest .  # OR\npytest\n```\n\n```bash\n# Code Coverage\npytest --cov=fastvector tests --cov-report=html\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffranneck94%2Fpythonprojecttemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffranneck94%2Fpythonprojecttemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffranneck94%2Fpythonprojecttemplate/lists"}