xync-schema 0.0.54.dev3__tar.gz

xync_schema-0.0.54.dev3/.env.sample

@@ -0,0 +1,2 @@
+DB_URL=postgres://user:password@host/db_name
+VENV=.venv

xync_schema-0.0.54.dev3/.gitignore

@@ -0,0 +1,7 @@
+/.idea/
+/*.egg-info
+/dist
+/.env
+/venv
+__pycache__
+/build

xync_schema-0.0.54.dev3/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+- repo: local
+  hooks:
+  - id: pytest
+    name: pytest
+    entry: pytest tests -v
+    language: python
+    types: [python]
+    verbose: true
+    stages: [pre-commit]
+
+  - id: tag
+    name: tag
+    ### make tag with next ver only if "fix" in commit_msg or starts with "feat"
+    entry: bash -c 'grep -e "^feat:" -e "^fix:" .git/COMMIT_EDITMSG && make patch || exit 0'
+    language: system
+    verbose: true
+    pass_filenames: false
+    always_run: true
+    stages: [post-commit]
+
+  - id: build
+    name: build
+    ### build & upload package only for "main" branch push
+    entry: bash -c 'echo $PRE_COMMIT_LOCAL_BRANCH | grep /main && make twine || echo 0'
+    language: system
+    pass_filenames: false
+    verbose: true
+    require_serial: true
+    stages: [pre-push]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  ### Ruff version.
+  rev: v0.14.4
+  hooks:
+    ### Run the linter.
+    - id: ruff
+      args: [--fix]
+      stages: [pre-commit]
+    ### Run the formatter.
+    - id: ruff-format
+      types_or: [python, pyi]
+      verbose: true
+      stages: [pre-commit]

xync_schema-0.0.54.dev3/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: xync-schema
+Version: 0.0.54.dev3
+Summary: XyncNet project database model schema
+Author-email: Mike Artemiev <mixartemev@gmail.com>
+License: EULA
+Project-URL: Homepage, https://gitlab.com/xync/back/schema
+Project-URL: Repository, https://gitlab.com/xync/back/schema
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: aerich
+Requires-Dist: xn-auth
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Requires-Dist: setuptools-scm[toml]; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+## INSTALL
+```bash
+# Create python virtual environment
+python3 -m venv venv
+# Activate this environment
+source venv/bin/activate
+# Install dependencies
+pip install -r requirements.dev.txt
+
+# Create pg db
+createdb --U username -W dbname
+## set password for db user
+
+# Copy .env file from sample template
+cp .env.sample .env
+## set your pg creds in .env file
+```
+
+## TEST
+```bash
+pytest
+```
+
+
+### pre-commit
+You can done `commit` only after `pytest` will done success.
+Pre-commit script stored in `.git/hooks/pre-commit` file; current script is:
+```shell
+#!/bin/sh
+pytest
+```
+
+### Relations
+```mermaid
+classDiagram
+direction BT
+class Agent {
+   timestamp(0) with time zone created_at
+   timestamp(0) with time zone updated_at
+   integer exid
+   jsonb auth
+   smallint ex_id
+   bigint user_id
+   integer id
+}
+class Asset {
+   smallint type_  /* spot: 1\nearn: 2\nfound: 3 */
+   double precision free
+   double precision freeze
+   double precision lock
+   double precision target
+   integer agent_id
+   smallint coin_id
+   integer id
+}
+class Coin {
+   varchar(15) ticker
+   double precision rate
+   boolean is_fiat
+   smallint id
+}
+class CoinEx {
+   varchar(31) exid
+   boolean p2p
+   smallint coin_id
+   smallint ex_id
+   integer id
+}
+class Cur {
+   varchar(3) ticker
+   double precision rate
+   smallint id
+}
+class CurEx {
+   varchar(31) exid
+   boolean p2p
+   smallint cur_id
+   smallint ex_id
+   integer id
+}
+class Ex {
+   varchar(31) name
+   varchar(63) host  /* With no protocol 'https://' */
+   varchar(63) host_p2p  /* With no protocol 'https://' */
+   varchar(63) url_login  /* With no protocol 'https://' */
+   smallint type_  /* p2p: 1\ncex: 2\nmain: 3\ndex: 4\nfutures: 8 */
+   varchar(511) logo
+   smallint id
+}
+class Fiat {
+   varchar(127) detail
+   varchar(127) name
+   double precision amount
+   double precision target
+   integer pmcur_id
+   bigint user_id
+   integer id
+}
+class FiatEx {
+   integer exid
+   smallint ex_id
+   integer fiat_id
+   integer id
+}
+class Limit {
+   integer amount
+   integer unit
+   integer level
+   boolean income
+   bigint added_by_id
+   integer pmcur_id
+   integer id
+}
+class Pm {
+   varchar(63) name
+   smallint rank
+   smallint type_  /* bank: 0\nweb_wallet: 1\ncash: 2\ngift_card: 3\ncredit_card: 4 */
+   varchar(127) logo
+   boolean multiAllow
+   integer id
+}
+class PmCur {
+   smallint cur_id
+   integer pm_id
+   integer id
+}
+class PmCurEx {
+   boolean blocked
+   smallint ex_id
+   integer pmcur_id
+   integer id
+}
+class PmEx {
+   varchar(31) exid
+   smallint ex_id
+   integer pm_id
+   integer id
+}
+class User {
+   timestamp(0) with time zone created_at
+   timestamp(0) with time zone updated_at
+   smallint role  /* READER: 4\nWRITER: 2\nMANAGER: 6\nADMIN: 7 */
+   smallint status  /* CREATOR: 5\nADMINISTRATOR: 4\nMEMBER: 3\nRESTRICTED: 2\nLEFT:... */
+   varchar(95) username
+   bigint ref_id
+   bigint id
+}
+
+Agent  -->  Ex : ex_id-id
+Agent  -->  User : user_id-id
+Asset  -->  Agent : agent_id-id
+Asset  -->  Coin : coin_id-id
+CoinEx  -->  Coin : coin_id-id
+CoinEx  -->  Ex : ex_id-id
+CurEx  -->  Cur : cur_id-id
+CurEx  -->  Ex : ex_id-id
+Fiat  -->  PmCur : pmcur_id-id
+Fiat  -->  User : user_id-id
+FiatEx  -->  Ex : ex_id-id
+FiatEx  -->  Fiat : fiat_id-id
+Limit  -->  PmCur : pmcur_id-id
+Limit  -->  User : added_by_id-id
+PmCur  -->  Cur : cur_id-id
+PmCur  -->  Pm : pm_id-id
+PmCurEx  -->  Ex : ex_id-id
+PmCurEx  -->  PmCur : pmcur_id-id
+PmEx  -->  Ex : ex_id-id
+PmEx  -->  Pm : pm_id-id
+User  -->  User : ref_id-id
+```

xync_schema-0.0.54.dev3/README.md

@@ -0,0 +1,170 @@
+## INSTALL
+```bash
+# Create python virtual environment
+python3 -m venv venv
+# Activate this environment
+source venv/bin/activate
+# Install dependencies
+pip install -r requirements.dev.txt
+
+# Create pg db
+createdb --U username -W dbname
+## set password for db user
+
+# Copy .env file from sample template
+cp .env.sample .env
+## set your pg creds in .env file
+```
+
+## TEST
+```bash
+pytest
+```
+
+
+### pre-commit
+You can done `commit` only after `pytest` will done success.
+Pre-commit script stored in `.git/hooks/pre-commit` file; current script is:
+```shell
+#!/bin/sh
+pytest
+```
+
+### Relations
+```mermaid
+classDiagram
+direction BT
+class Agent {
+   timestamp(0) with time zone created_at
+   timestamp(0) with time zone updated_at
+   integer exid
+   jsonb auth
+   smallint ex_id
+   bigint user_id
+   integer id
+}
+class Asset {
+   smallint type_  /* spot: 1\nearn: 2\nfound: 3 */
+   double precision free
+   double precision freeze
+   double precision lock
+   double precision target
+   integer agent_id
+   smallint coin_id
+   integer id
+}
+class Coin {
+   varchar(15) ticker
+   double precision rate
+   boolean is_fiat
+   smallint id
+}
+class CoinEx {
+   varchar(31) exid
+   boolean p2p
+   smallint coin_id
+   smallint ex_id
+   integer id
+}
+class Cur {
+   varchar(3) ticker
+   double precision rate
+   smallint id
+}
+class CurEx {
+   varchar(31) exid
+   boolean p2p
+   smallint cur_id
+   smallint ex_id
+   integer id
+}
+class Ex {
+   varchar(31) name
+   varchar(63) host  /* With no protocol 'https://' */
+   varchar(63) host_p2p  /* With no protocol 'https://' */
+   varchar(63) url_login  /* With no protocol 'https://' */
+   smallint type_  /* p2p: 1\ncex: 2\nmain: 3\ndex: 4\nfutures: 8 */
+   varchar(511) logo
+   smallint id
+}
+class Fiat {
+   varchar(127) detail
+   varchar(127) name
+   double precision amount
+   double precision target
+   integer pmcur_id
+   bigint user_id
+   integer id
+}
+class FiatEx {
+   integer exid
+   smallint ex_id
+   integer fiat_id
+   integer id
+}
+class Limit {
+   integer amount
+   integer unit
+   integer level
+   boolean income
+   bigint added_by_id
+   integer pmcur_id
+   integer id
+}
+class Pm {
+   varchar(63) name
+   smallint rank
+   smallint type_  /* bank: 0\nweb_wallet: 1\ncash: 2\ngift_card: 3\ncredit_card: 4 */
+   varchar(127) logo
+   boolean multiAllow
+   integer id
+}
+class PmCur {
+   smallint cur_id
+   integer pm_id
+   integer id
+}
+class PmCurEx {
+   boolean blocked
+   smallint ex_id
+   integer pmcur_id
+   integer id
+}
+class PmEx {
+   varchar(31) exid
+   smallint ex_id
+   integer pm_id
+   integer id
+}
+class User {
+   timestamp(0) with time zone created_at
+   timestamp(0) with time zone updated_at
+   smallint role  /* READER: 4\nWRITER: 2\nMANAGER: 6\nADMIN: 7 */
+   smallint status  /* CREATOR: 5\nADMINISTRATOR: 4\nMEMBER: 3\nRESTRICTED: 2\nLEFT:... */
+   varchar(95) username
+   bigint ref_id
+   bigint id
+}
+
+Agent  -->  Ex : ex_id-id
+Agent  -->  User : user_id-id
+Asset  -->  Agent : agent_id-id
+Asset  -->  Coin : coin_id-id
+CoinEx  -->  Coin : coin_id-id
+CoinEx  -->  Ex : ex_id-id
+CurEx  -->  Cur : cur_id-id
+CurEx  -->  Ex : ex_id-id
+Fiat  -->  PmCur : pmcur_id-id
+Fiat  -->  User : user_id-id
+FiatEx  -->  Ex : ex_id-id
+FiatEx  -->  Fiat : fiat_id-id
+Limit  -->  PmCur : pmcur_id-id
+Limit  -->  User : added_by_id-id
+PmCur  -->  Cur : cur_id-id
+PmCur  -->  Pm : pm_id-id
+PmCurEx  -->  Ex : ex_id-id
+PmCurEx  -->  PmCur : pmcur_id-id
+PmEx  -->  Ex : ex_id-id
+PmEx  -->  Pm : pm_id-id
+User  -->  User : ref_id-id
+```

xync_schema-0.0.54.dev3/makefile

@@ -0,0 +1,27 @@
+include .env
+PACKAGE := xync_schema
+VPYTHON := $(VENV)/bin/python
+
+.PHONY: all install pre-commit test clean build twine patch
+
+all:
+	make install test clean build
+
+install: $(VENV)
+	$(VPYTHON) -m pip install -e .[dev]; make pre-commit
+pre-commit: .pre-commit-config.yaml
+	pre-commit install -t pre-commit -t post-commit -t pre-push
+
+test:
+	$(VPYTHON) -m pytest
+
+clean: .pytest_cache dist $(PACKAGE).egg-info
+	rm -rf .pytest_cache dist/* $(PACKAGE).egg-info $(PACKAGE)/__pycache__ dist/__pycache__
+
+build:
+	$(VPYTHON) -m build
+twine: build dist
+	$(VPYTHON) -m twine upload dist/* --skip-existing
+
+patch:
+	git tag `$(VPYTHON) -m setuptools_scm --strip-dev`; git push --tags --prune -f

xync_schema-0.0.54.dev3/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "xync-schema"
+requires-python = ">=3.11"
+authors = [
+    {name = "Mike Artemiev", email = "mixartemev@gmail.com"},
+]
+description = "XyncNet project database model schema"
+readme = "README.md"
+license = {text = "EULA"}
+dynamic = ["version"]
+
+dependencies = [
+    "aerich",
+    "xn-auth",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "pre-commit",
+    "pytest-asyncio",
+    "python-dotenv",
+    "setuptools-scm[toml]",
+    "twine",
+]
+[project.urls]
+Homepage = "https://gitlab.com/xync/back/schema"
+Repository = "https://gitlab.com/xync/back/schema"
+
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm[toml]>=8"]
+build-backend = "setuptools.build_meta"
+[tool.setuptools_scm]
+version_scheme = "python-simplified-semver" # if "feature" in `branch_name` SEMVER_MINOR++ else SEMVER_PATCH++
+local_scheme = "no-local-version"
+
+[tool.setuptools]
+packages = ["xync_schema"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+line-length = 120

xync_schema-0.0.54.dev3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xync_schema-0.0.54.dev3/tests/test_db.py

@@ -0,0 +1,24 @@
+import pytest
+from dotenv import load_dotenv
+from tortoise.backends.asyncpg import AsyncpgDBClient
+from x_model import init_db
+
+from xync_schema import TORM
+
+load_dotenv()
+
+
+@pytest.fixture
+async def _dbc() -> AsyncpgDBClient:
+    cn: AsyncpgDBClient = await init_db(TORM, True)
+    yield cn
+    await cn.close()
+
+
+async def test_init_db(_dbc):
+    assert isinstance(_dbc, AsyncpgDBClient), "DB corrupt"
+
+
+# async def test_models(_dbc):
+#     c = await models.Ex.first()
+#     assert isinstance(c, models.Ex), "No exs"

xync_schema-0.0.54.dev3/xync_schema/__init__.py

@@ -0,0 +1,28 @@
+from os import getenv as env
+from dotenv import load_dotenv
+
+from xync_schema import models
+
+load_dotenv()
+
+TORM = {
+    "connections": {"default": env("DB_URL")},
+    "apps": {"models": {"models": [models, "aerich.models"]}},
+    "use_tz": False,
+    "timezone": "UTC",
+}
+
+
+async def main():
+    import logging
+    from x_model import init_db
+    from logging import DEBUG
+
+    logging.basicConfig(level=DEBUG)
+    await init_db(TORM, True)
+
+
+if __name__ == "__main__":
+    from asyncio import run
+
+    run(main())