From d9dd8ac244008f5560caaf7422f9814f7a03d176 Mon Sep 17 00:00:00 2001 From: berkay Date: Fri, 21 Mar 2025 14:15:22 +0300 Subject: [PATCH] updated ReadMe.md --- .dockerignore | 93 +++++++++++++++++++++++++++++ .gitignore | 162 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 88 +++++++++++++++++++++++++++ new_file | 1 - 4 files changed, 343 insertions(+), 1 deletion(-) create mode 100644 .dockerignore create mode 100644 .gitignore create mode 100644 README.md delete mode 100644 new_file diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..1449c90 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,93 @@ +# Git +.git +.gitignore +.gitattributes + + +# CI +.codeclimate.yml +.travis.yml +.taskcluster.yml + +# Docker +docker-compose.yml +service_app/Dockerfile +.docker +.dockerignore + +# Byte-compiled / optimized / DLL files +**/__pycache__/ +**/*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +service_app/env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# 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/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Virtual environment +service_app/.env +.venv/ +venv/ + +# PyCharm +.idea + +# Python mode for VIM +.ropeproject +**/.ropeproject + +# Vim swap files +**/*.swp + +# VS Code +.vscode/ + +test_application/ + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f852d0e --- /dev/null +++ b/.gitignore @@ -0,0 +1,162 @@ +# ---> Python +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.idea/ +.Python +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 +service_app/.env +.venv +service_app/env/ +venv/ +service_app/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/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..1f3371e --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ + + +uv add arrow alembic fastapi uvicorn sqlalchemy-mixins redis psycopg2-binary pymongo rsa redmail unidecode textdistance pandas faker requests cryptography + +user_creds_create +user_creds_update + +timezone Comparator must be used as GMT+0 and users GMT+X +[Base Collection don't have find_one / find_all bla bla]ApiEnumDropdown: functions [ + enum_class = mapped_column(String, nullable=False, comment="Enum Constant Name") + key = mapped_column(String, nullable=False, comment="Enum Key") + value = mapped_column(String, nullable=False, comment="Enum Value") + description = mapped_column(String, nullable=True) +] +BuildType: functions [ + build_type = mapped_column(String, nullable=False, comment="Build Type") + description = mapped_column(String, nullable=True) +] +OccupantType: functions [ + occupant_type = mapped_column(String, nullable=False, comment="Occupant Type") + description = mapped_column(String, nullable=True) +] + +create & update & select +is_confirmed = True + +find_one / find_all is found @Database +is_confirmed = False raise Exception Record is in database but not confirmed by supervisor + +find_or_create -> If record is not found create it +if found.is_deleted = True: return "Record is found but deleted. Please contact your supervisor" +if found.is_confirmed = False: return "Record is found but not confirmed by supervisor" + + +update Which fields are possible to update +except +- is_confirmed + +delete -> Update is_deleted = True +except +- id + +destroy -> Only available for system + +patch -> Only available for system [event] Retrieve available events for token user + ++ Occupant Information + +Occupant [Settings] -> Event Group [Settings] +Occupant [Accounts] -> Event Group [Accounts] +Occupant [Decision Book] -> Event Group [Decision Book] +Occupant [Projects] -> Event Group [Projects] +Occupant [Events] -> Event Group [Events] +Occupant [Company] -> Event Group [Company] +Occupant [People] -> Event Group [People] +Occupant [Build] -> Event Group [Build] +Occupant [Address] -> Event Group [Address] + + +ApiActions: + insert_ + insert_bulk + update_ + update_bulk + delete_ + delete_bulk + patch_ + patch_bulk + +InnerJoin: + pass + + +class FilterFromUser: + raise_exception = FilterModelofEvent(**filter_records) + +HTTP_404_NOT_FOUND make available for Next.js +HTTP_401_UNAUTHORIZED make available for Next.js +HTTP_403_FORBIDDEN make available for Next.js +HTTP_400_BAD_REQUEST make available for Next.js + + +class DecisionBookDecisionBookItemsListEventMethods(MethodToEvent): + + event_type = "SELECT" + __event_keys__ = { + "eb36de59-8268-4d96-80b6-5d01c12bf0b1": "building_decision_book_items_list", + } + event_description = "List Decision Book Items" \ No newline at end of file diff --git a/new_file b/new_file deleted file mode 100644 index f5729af..0000000 --- a/new_file +++ /dev/null @@ -1 +0,0 @@ -asdasdasdasdasdasd \ No newline at end of file