chore(test_and_publish.yml): Add publish step

.github/workflows/test.yml → .github/workflows/test_and_publish.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Tests
+name: Test and Publish
 
 on:
   push:
@@ -10,17 +10,18 @@ on:
     branches: [ "master" ]
 
 jobs:
-  check-format:
+  check-style:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
     - name: Install dependencies
       run: |
         pip install --upgrade pip
         pip install -e ".[dev]"
-    - name: Check with ruff
+    - name: Check style with ruff
       run: |
         ruff check .
+
   test:
     runs-on: ubuntu-latest
     strategy:
@@ -41,3 +42,21 @@ jobs:
     - name: Test with pytest
       run: |
         pytest .
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    needs: [check-format, test]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip
+        pip install flit
+    - name: Publish with flit
+      run: |
+        flit publish

README.md

@@ -8,15 +8,15 @@ Library to define configurations using python files.
 ## Installation
 Recommended installation with pip:
 ```bash
-pip install cfg
+pip install rizhiy-cfg
 ```
 
 ### Usage
 1) Define config schema:
 
 ```python
 # project/config.py
-from cfg import CL, CN
+from rizhiy_cfg import CL, CN
 
 class BaseClass:
     pass
@@ -52,7 +52,7 @@ cfg.add_hook(hook)
 2) Set actual values for each leaf in the config, **the import has to be absolute**:
 ```python
 # my_cfg.py
-from cfg import CN
+from rizhiy_cfg import CN
 
 from project.config import cfg # Import has to be absolute
 
@@ -82,7 +82,7 @@ There a few restrictions on imports in configs:
 3) Load actual config and use it in the code.
 ```python
 # main.py
-from ntc import CN
+from rizhiy_cfg import CN
 
 cfg = CN.load("my_cfg.py")
 # Access values as attributes