ovinnik 0.1.0__tar.gz

ovinnik-0.1.0/.gitignore

@@ -0,0 +1,142 @@
+.idea
+.vscode
+
+*.sqlite3
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.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/

ovinnik-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Pavel Kirilin
+Copyright (c) 2026 Grigorii Novikov
+
+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.

ovinnik-0.1.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.5
+Name: ovinnik
+Version: 0.1.0
+Summary: Feature-rich robust FastAPI project generator
+Project-URL: Homepage, https://github.com/Oper18/ovinnik
+Project-URL: Repository, https://github.com/Oper18/ovinnik
+Project-URL: Upstream, https://github.com/s3rius/FastAPI-template
+Author-email: Grigorii Novikov <genovikov93@gmail.com>, Pavel Kirilin <win10@list.ru>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Cookiecutter,FastAPI,Template
+Requires-Python: <4,>=3.9
+Requires-Dist: click<9,>=8.1.3
+Requires-Dist: cookiecutter<2,>=1.7.3
+Requires-Dist: pre-commit<3,>=2.14.0
+Requires-Dist: prompt-toolkit<4,>=3.0.36
+Requires-Dist: pydantic>=1.10
+Requires-Dist: simple-term-menu<2,>=1.5.2
+Requires-Dist: termcolor<2,>=1.1.0
+Description-Content-Type: text/markdown
+
+## Usage
+
+⚠️ [Git](https://git-scm.com/downloads), [Python](https://www.python.org/) and [UV](https://docs.astral.sh/uv/) must be installed and accessible ⚠️
+
+You can install it directly from pypi with pip.
+```bash
+python3 -m pip install ovinnik
+python3 -m ovinnik
+# or ovinnik
+# Answer all the questions
+# 🍪 Enjoy your new project 🍪
+cd new_project
+docker-compose up --build
+```
+
+If you want to install it from sources, try this:
+```shell
+python3 -m pip install uv 
+python3 -m pip install .
+python3 -m ovinnik
+```
+
+Also, you can use it with docker.
+```bash
+docker run --rm -it -v "$(pwd):/projects" ghcr.io/oper18/ovinnik
+```
+
+## Features
+
+One of the coolest features is that this project is extremely configurable.
+You can choose between different databases and even ORMs, or
+you can even generate a project without a database!
+Currently SQLAlchemy 2.0, TortoiseORM, Piccolo, Ormar and Beanie are supported.
+
+This project can run as TUI or CLI and has excellent code documentation.
+
+Generator features:
+- Pydantic V2 (Where it's possible. Some libs doesn't have support);
+- You can choose between GraphQL and REST api;
+- Uvicorn and gunicorn;
+- Different databases support;
+- Different ORMs support;
+- Optional migrations for each ORM except raw drivers;
+- Optional redis support;
+- Optional rabbitmq support;
+- different CI\CD;
+- Optional Demo routers and models (This helps you to see how project is structured);
+- Pre-commit integration;
+- Generated tests with almost 90% coverage;
+- Tests for the generator itself;
+- Optional Prometheus integration;
+- Optional Sentry integration;
+- Optional Loguru logger;
+- Optional Opentelemetry integration.
+- Optional taskiq integration.
+
+
+This project can handle arguments passed through command line.
+
+```shell
+$ python -m ovinnik --help
+
+Usage: ovinnik [OPTIONS]
+
+Options:
+  -n, --name TEXT                 Name of your awesome project
+  -V, --version                   Prints current version
+  --force                         Owerrite directory if it exists
+  --quiet                         Do not ask for features during generation
+  --api-type [rest|graphql]       Select API type for your application
+  --db [none|sqlite|mysql|postgresql|mongodb]
+                                  Select a database for your app
+  --orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo|beanie]
+                                  Choose Object–Relational Mapper lib
+  --ci [none|gitlab_ci|github]    Select a CI for your app
+  --redis                         Add redis support
+  --add_users                     Add fastapi-users support
+  --rabbit                        Add RabbitMQ support
+  --taskiq                        Add Taskiq support
+  --migrations                    Add Migrations
+  --dummy                         Add dummy model
+  --routers                       Add example routers
+  --swagger                       Add self hosted swagger
+  --prometheus                    Add prometheus compatible metrics
+  --sentry                        Add sentry integration
+  --loguru                        Add loguru logger
+  --opentelemetry                 Add opentelemetry integration
+  --traefik                       Adds traefik labels to docker container
+  --kafka                         Add Kafka support
+  --gunicorn                      Add gunicorn server
+  --cookie-auth                   Add authentication via cookie support
+  --jwt-auth                      Add JWT auth support
+  --help                          Show this message and exit.
+```

ovinnik-0.1.0/README.md

@@ -0,0 +1,94 @@
+## Usage
+
+⚠️ [Git](https://git-scm.com/downloads), [Python](https://www.python.org/) and [UV](https://docs.astral.sh/uv/) must be installed and accessible ⚠️
+
+You can install it directly from pypi with pip.
+```bash
+python3 -m pip install ovinnik
+python3 -m ovinnik
+# or ovinnik
+# Answer all the questions
+# 🍪 Enjoy your new project 🍪
+cd new_project
+docker-compose up --build
+```
+
+If you want to install it from sources, try this:
+```shell
+python3 -m pip install uv 
+python3 -m pip install .
+python3 -m ovinnik
+```
+
+Also, you can use it with docker.
+```bash
+docker run --rm -it -v "$(pwd):/projects" ghcr.io/oper18/ovinnik
+```
+
+## Features
+
+One of the coolest features is that this project is extremely configurable.
+You can choose between different databases and even ORMs, or
+you can even generate a project without a database!
+Currently SQLAlchemy 2.0, TortoiseORM, Piccolo, Ormar and Beanie are supported.
+
+This project can run as TUI or CLI and has excellent code documentation.
+
+Generator features:
+- Pydantic V2 (Where it's possible. Some libs doesn't have support);
+- You can choose between GraphQL and REST api;
+- Uvicorn and gunicorn;
+- Different databases support;
+- Different ORMs support;
+- Optional migrations for each ORM except raw drivers;
+- Optional redis support;
+- Optional rabbitmq support;
+- different CI\CD;
+- Optional Demo routers and models (This helps you to see how project is structured);
+- Pre-commit integration;
+- Generated tests with almost 90% coverage;
+- Tests for the generator itself;
+- Optional Prometheus integration;
+- Optional Sentry integration;
+- Optional Loguru logger;
+- Optional Opentelemetry integration.
+- Optional taskiq integration.
+
+
+This project can handle arguments passed through command line.
+
+```shell
+$ python -m ovinnik --help
+
+Usage: ovinnik [OPTIONS]
+
+Options:
+  -n, --name TEXT                 Name of your awesome project
+  -V, --version                   Prints current version
+  --force                         Owerrite directory if it exists
+  --quiet                         Do not ask for features during generation
+  --api-type [rest|graphql]       Select API type for your application
+  --db [none|sqlite|mysql|postgresql|mongodb]
+                                  Select a database for your app
+  --orm [none|ormar|sqlalchemy|tortoise|psycopg|piccolo|beanie]
+                                  Choose Object–Relational Mapper lib
+  --ci [none|gitlab_ci|github]    Select a CI for your app
+  --redis                         Add redis support
+  --add_users                     Add fastapi-users support
+  --rabbit                        Add RabbitMQ support
+  --taskiq                        Add Taskiq support
+  --migrations                    Add Migrations
+  --dummy                         Add dummy model
+  --routers                       Add example routers
+  --swagger                       Add self hosted swagger
+  --prometheus                    Add prometheus compatible metrics
+  --sentry                        Add sentry integration
+  --loguru                        Add loguru logger
+  --opentelemetry                 Add opentelemetry integration
+  --traefik                       Adds traefik labels to docker container
+  --kafka                         Add Kafka support
+  --gunicorn                      Add gunicorn server
+  --cookie-auth                   Add authentication via cookie support
+  --jwt-auth                      Add JWT auth support
+  --help                          Show this message and exit.
+```

ovinnik-0.1.0/ovinnik/__main__.py

@@ -0,0 +1,42 @@
+from pathlib import Path
+
+from cookiecutter.exceptions import FailedHookException, OutputDirExistsException
+from cookiecutter.main import cookiecutter
+from termcolor import cprint
+
+from ovinnik.cli import run_command
+from ovinnik.input_model import BuilderContext
+
+script_dir = Path(__file__).parent
+
+
+def generate_project(context: BuilderContext) -> None:
+    """
+    Generate actual project with given context.
+
+    :param context: builder_context
+    """
+    try:
+        cookiecutter(
+            template=f"{script_dir}/template",
+            extra_context=context.dict(),
+            default_config=True,
+            no_input=True,
+            overwrite_if_exists=context.force,
+        )
+    except (FailedHookException, OutputDirExistsException) as exc:
+        if isinstance(exc, OutputDirExistsException):
+            cprint("Directory with such name already exists!", "red")
+        return
+    cprint(
+        "Project successfully generated. You can read information about usage in README.md"
+    )
+
+
+def main() -> None:
+    """Starting point."""
+    run_command(generate_project)
+
+
+if __name__ == "__main__":
+    main()