diff --git a/.github/workflows/app.yml b/.github/workflows/app.yml new file mode 100644 index 0000000..56500f5 --- /dev/null +++ b/.github/workflows/app.yml @@ -0,0 +1,20 @@ +name: Python application + +on: push + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Build docker image + run: docker build -t tink-ab-hw8 . + + - name: Run tests + run: docker run -t tink-ab-hw8 pytest diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b855ff8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,161 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ +.idea diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..265cac1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2023 The Python Packaging Authority + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2609ab --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Разработка в команде + +![][img] + +## I. Практическое задание (оно же ДЗ) + +1. Разбивка на команды (2-3 человека). +2. Состав проекта: + - REST API (любой фреймворк) + - БД (любая, но лучше Postgres) + - Tests + - Poetry + - Docker + - Type hints + - Linters (можно ruff) + - Github Actions pipeline +3. Распределение ролей в команде и создание backlog'a задач. +4. Работа над заданиями в соответствии с ролями и ответственностями. +5. Применение практик совместной работы: + - создание веток в репозитории + - pull requests + - code review + - bug fixing + - рефакторинг +6. Ретроспектива и обсуждение: + - Что получилось хорошо? + - Где возникли сложности? + - Как совместную работу можно улучшить? + +## Критерии успеха: + +- Учтено всё, что описано выше (в первую очередь из пункта 2) +- Работающий API сервис с основным функционалом. +- Приложение должно быть упаковано в Docker контейнер для легкого развертывания. +- Использование poetry для управления зависимостями. +- Отсутствие ошибок линтера ruff. +- Написание документации к API (описание эндпоинтов, методов и форматов данных). +- Наличие автоматических тестов, покрывающих основную функциональность. +- Покрытие тестами не менее 80%. + +Максимальный бал за ДЗ - 10. + +--- + +[img]: assets/img/img.png diff --git a/assets/img/img.png b/assets/img/img.png new file mode 100644 index 0000000..1d555e5 Binary files /dev/null and b/assets/img/img.png differ diff --git a/assets/materials/template.md b/assets/materials/template.md new file mode 100644 index 0000000..b6b56e9 --- /dev/null +++ b/assets/materials/template.md @@ -0,0 +1,14 @@ +[Вернуться][main] + +--- + +# + +--- + +[Вернуться][main] + + +[main]: ../../README.md "содержание" + +[Pigeonhole_principle]: https://ru.wikipedia.org/wiki/Принцип_Дирихле_(комбинаторика) "pigeonhole principle" diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..665ccb0 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,22 @@ +[build-system] +requires = ["setuptools>=68.1"] +build-backend = "setuptools.build_meta" + +[project] +name = "homework_10" +version = "0.0.1" +authors = [ + { name="Dmitry Kosarevsky", email="if@kosarevsky.ru" }, +] +description = "A Tinkoff Python AB hw-10 package" +readme = "README.md" +requires-python = ">=3.12" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] + +[project.urls] +"Homepage" = "https://github.com/central-university-dev/python-hw-10-template" +"Bug Tracker" = "https://github.com/central-university-dev/python-hw-10-template/issues" diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/homework/__init__.py b/src/homework/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/homework/main.py b/src/homework/main.py new file mode 100644 index 0000000..bf65d86 --- /dev/null +++ b/src/homework/main.py @@ -0,0 +1,6 @@ +def main() -> None: + ... + + +if __name__ == '__main__': + main() diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29