Add docs, refactoring, and simplification (#14)

* Add `FQN` for Entites, Attributes, Groups, and Links
* Init documentation
* Init a Tutorial
* Update dependencies
* Remove SqlAlchemy dependency
* Simplify interfaces: `migation` and `task`
* Refactor tests

Author: marchinho11

.github/workflows/docs.yaml

@@ -0,0 +1,19 @@
+on:
+  workflow_call:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: pipx install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+      - run: poetry install
+
+      - run: poetry run pydoc-markdown
+
+      - run: poetry run mkdocs gh-deploy --force
+        working-directory: docs/build

.github/workflows/lint.yaml

@@ -8,7 +8,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: psf/black@stable
         with:
-          version: "23.1.0"
+          version: "23.3.0"
 
   isort:
     runs-on: ubuntu-latest

.github/workflows/release.yaml

@@ -1,13 +1,16 @@
 name: "Release"
 
 on:
-  push:
-    tags: [ "*.*.*" ]
+  release:
+    types: [ published ]
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}
   cancel-in-progress: true
 
+permissions:
+  contents: write
+
 jobs:
   lint:
     uses: ./.github/workflows/lint.yaml
@@ -33,3 +36,7 @@ jobs:
       - run: poetry build
       - run: poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
       - run: poetry publish
+
+  docs:
+    needs: [ pypi ]
+    uses: ./.github/workflows/docs.yaml

.gitignore

@@ -11,3 +11,6 @@ htmlcov/
 .env
 
 state.json
+coinmarket.json
+
+docs/build

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 23.1.0
+    rev: 23.3.0
     hooks:
       - id: black
         language_version: python3.10

Makefile

@@ -6,3 +6,6 @@ test:
 
 lines:
 	@poetry run pygount --format=summary --suffix=py hnhm/
+
+lines-all:
+	@poetry run pygount --format=summary --suffix=py hnhm/ tests/

README.md

@@ -1,15 +1,19 @@
-# <img src="assets/logo.png" height="40px">
+# <img src="docs/assets/logo.png" height="40px">
 [![codecov](https://codecov.io/gh/marchinho11/hnhm/branch/main/graph/badge.svg?token=PFB1111T2D)](https://codecov.io/gh/marchinho11/hnhm)
 [![Release](https://github.com/marchinho11/hnhm/actions/workflows/release.yaml/badge.svg?branch=main&event=push)](https://github.com/marchinho11/hnhm/actions/workflows/release.yaml)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Downloads](https://static.pepy.tech/personalized-badge/hnhm?period=week&units=international_system&left_color=black&right_color=brightgreen&left_text=PyPi%20/%20week)](https://pepy.tech/project/hnhm)
+[![Downloads](https://static.pepy.tech/personalized-badge/hnhm?period=total&units=international_system&left_color=black&right_color=brightgreen&left_text=PyPi%20/%20total)](https://pepy.tech/project/hnhm)
+![Visitors](https://api.visitorbadge.io/api/combined?path=marchinho11%2Fhnhm&label=Visitors&labelColor=%23000000&countColor=%2347c21a&style=flat&labelStyle=none)
 
 **hNhM**(highly Normalized hybrid Model) – data modeling methodology based on Anchor modeling and Data Vault. Implementation of this package is based on report **"How we implemented our data storage model — highly Normalized hybrid Model"** by Evgeny Ermakov and Nikolai Grebenshchikov. 
 [1) Yandex Report, habr.com](https://habr.com/ru/company/yandex/blog/557140/). [2) SmartData Conference, youtube.com](https://youtu.be/2fPqDvHsd0w)
-
+* [Documentation](#documentation)
 * [Basic hNhM concepts](#basic-hnhm-concepts)
 * [Quick Start](#quick-start)
-* [DWH example](#dwh-example)
-* [Guide](#guide)
+
+### Documentation
+https://marchinho11.github.io/hnhm
 
 ### Basic hNhM concepts
 **Logical level**
@@ -34,9 +38,10 @@ Install `hnhm` library
 pip install hnhm
 ```
 
-Create a directory with the name `dwh` and put the `__init__.py` file there with the following contents:
+Create a directory with the name `dwh` and put the `__hnhm__.py` file there with the following contents:
+
 ```python
-# dwh/__init__.py
+# dwh/__hnhm__.py
 from hnhm import (
     Layout,
     LayoutType,
@@ -46,8 +51,8 @@ from hnhm import (
     HnHm,
     HnhmEntity,
     HnhmRegistry,
-    FileStorage,
-    PostgresSqlalchemySql
+    FileState,
+    PostgresPsycopgSql
 )
 
 
@@ -63,12 +68,13 @@ class User(HnhmEntity):
 
     __keys__ = [user_id]
 
-    
-__registry__ = HnhmRegistry(
+sql=PostgresPsycopgSql(database="hnhm", user="postgres")
+
+registry = HnhmRegistry(
     entities=[User()],
     hnhm=HnHm(
-        storage=FileStorage("state.json"),
-        sql=PostgresSqlalchemySql(database="hnhm", user="postgres"),
+        state=FileState("state.json"),
+        sql=sql,
     ),
 )
 ```
@@ -79,7 +85,7 @@ $ hnhm apply dwh
 
 Plan:
 
-+ entity 'user'
++ entity 'HNHM.user'
   + view 'user'
   + hub 'user'
   + attribute 'age'
@@ -107,8 +113,3 @@ view: entity__user
  │ + _loaded_at      │
  └───────────────────┘
 ```
-
-## DWH example
-Full DWH example including Entities, Links and Flows can be found in the [`dwh/`](dwh/) directory.
-
-## Guide

docs/assets/color_scheme.css

@@ -0,0 +1,6 @@
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color:        #2e303e; /* Panel */
+  --md-default-bg-color:        #2e303e; /* BG */
+  --md-typeset-a-color:         #8e91aa;
+  --md-accent-fg-color:         #658eda
+}