Dev

.gitignore

@@ -128,3 +128,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 .vscode
+
+*.json

README.md

@@ -1,60 +1,138 @@
 # **_FoxLin_**
-simple, fast, funny json dbms base on python
+simple, fast, funny column based dbms on python
+
+### philosophy
+Foxlin is developed to create the best User experience of DBMS interface for mini projects
+it is fast because use of numpy array for contain columns data in memory
+and using pydantic for manage data in program
+
+also have powerfull process managers.
+
+### feature
+ * simple & fast
+ * friendly ux
+ * auto backup
+ * nosql structure
+ * power full query tool based on sql concept
+ * logging
+ * async #TODO in 1.1
+ * smart cache system # TODO in 1.2
+ * query cache system # TODO in 1.2
 
 ### Quick access :
- - docs : [todo]()
+ - [docs](https://GitHub.com/MisanoGo/FoxLin/blob/stable/docs)
  - pypi : [todo]()
- - code : [todo]()
+ - [code](https://GitHub.com/MisanoGo/FoxLin)
 
 
-### Futures :
->   - TODO
+### requirements
+ * numpy
+ * pydantic
+ * orjson
 
+### Table Structure
+TODO
 
-## simple usage : 
-```Python
-    from foxlin import FoxLin, Schema
+## installation
 
-    class MyTable(schema): # define your teble schema
-        name: str
-        username: str
-        password: str
+### from pypi
+```console
+$ pip install foxlin
+```
 
-    db = FoxLin('./db.json', MyTable)
+### from github
+``` console
+$ git clone https://github.com/MisanoGo/FoxLin && cd FoxLin
+$ pytest # run tests
+$ pip install -e setup.py
+```
+
+## simple usage :
+```Python
+from foxlin import FoxLin, Schema, column
 
-    data = [
-        MyTable(name='sobhan', username='misano', password='#197382645#'),
-        MyTable(name='Tommy', username='god_of_war', password='123QWEasdZXC')
-    ]
+class MyTable(schema):
+    # define your teble schema
+    name: str = column(dtype=str)
+    age: int = column(dtype=int)
+    username: str = column(uniqe=True, dtype=str)
+    password: str = column(dtype=str)
 
-    with db.session as db_session:
-        db_session.INSERT(*data)
+db = FoxLin('./db.json', MyTable) # create db
 
-    # OR 
+data = [
+    MyTable(name='brian', age=37, username='biran1999', password='123456789')
+    MyTable(name='sobhan', age=20, username='misano', password='#197382645#'),
+    MyTable(name='Tommy', age=15, username='god_of_war', password='123QWEasdZXC')
+    MyTable(name='Ali', age=20, username='p_1969_q', password='@QWE123KFH@')
+]
 
-    db_session = db.sessionFactory
-    db_session.INSERT(*data)
-    db_session.COMMIT()
+with db.session as db_session:
+    db_session.insert(*data)
+    # auto commit in the end of context manager
 
-    r_data = db_session.SELECT().WHERE('name','=','sobhan').get()
-    myrecord = r_data[0]
+query = db.query
+record = query.where(query.age > 17, query.name == 'Ali').order_by(query.age).first()
 
-    print(myrecord.name, myrecord.username, myrecord.password)
+print(record.name, record.username, record.password)
 ```
 
+### Note
+ - every crud operation on db has O(record_count * column_count) order
+
+## FoxLin Story
+
+Sophy was a curious girl, always looking to learn and explore new things. One day, she found herself surrounded by a dense forest, enchanted by the beauty and mystery it held.
+
+As she walked further into the woods, she stumbled upon a Fox named Lin. Unlike other animals that would normally run away, Lin was as curious as Sophy was. Struck by their shared curiosity, they started talking.
+
+Sophy soon realized that Lin was not just any fox but an intelligent fox with considerable knowledge in the world of data. Excited by this, Sophy began asking Lin questions, eager to learn as much as she could.
+
+As they continued their conversation, they stumbled upon a huge database hidden in the forest that no one else had any idea about. Together, they navigated the vast expanse of knowledge within the database, reading and learning so many new things.
+
+Sophy and Lin lost track of time, as they quenched their thirst for knowledge in this world of data.
+
+As they walked back towards their homes, both of them were overcome with a sense of fulfillment and satisfaction. They realized that the world was full of secrets waiting to be unraveled, and it was up to them to quench their thirst for knowledge and explore all the possibilities.
+
+From that day on, Sophy and Lin would often visit the database and other places together, learning new things and exploring the world of data. They knew that knowledge had no limit and that there was always something new to discover, and it was this knowledge that would bring them closer every day.
+(generated by ai).
+
+
+**my experience from this project**
+ * in operations with high order, when have many static if,else(no change in all of program)
+ it's better to split their by classes and use factory clasess for select own usefull class, etc : columns.py:column
+
+
+## TODO
+
 ##### TODO in 1.0
 - [x] crud
 - [x] level base operation manager
 - [x] self log system
 - [x] session model
 - [x] transaction but by grouping commits **not ACDI**
-- [ ] write test
-- [ ] neo dict implemented by numpy
-- [ ] add logs to .<database-name>.logs
-- [ ] genetate logs
-- [ ] quering
+- [x] write test
+- [x] benchmarck test
+- [x] add logs to .logs file
+- [x] define logs in operation statment and able to setting by user
+- [x] generate logs
+- [x] quering
+- [x] auto backup
 
 ##### TODO at 1.1
 - asynchronus
 - transaction ACDI
+- define Group By & HAVING
+- log time duration of operation's 
+- migrate
+- stub
+- data compretion
+
+##### TODO at 1.2
+- memory cache system
+- query cache system
+- session privilege's
+- multi table
+- ...
+
 

config/settings.py

@@ -0,0 +1,9 @@
+# FoxLin Configuration file
+
+import os
+
+from pathlib import Path
+
+BASE_DIR = os.path.realpath(Path(__file__).parent.parent)
+
+AUTO_RUNNING_TESTS = False

documents/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

documents/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

documents/source/HOW_TO.rst

@@ -0,0 +1,19 @@
+:orphan:
+
+
+TODO : write discription
+========================
+
+how to : disable log
+.. code-block:: Python
+
+    db = FoxLin(...)
+    db.disable_box('log')
+
+
+how to : use just in memory
+===========================
+.. code-block:: Python
+
+    db = FoxLin(..., auto_setup=False)
+    db.disable_box('jsonfile') # return True if success

documents/source/HOW_WORK.rst

@@ -0,0 +1 @@
+:orphan:

documents/source/QUICK_START.rst

@@ -0,0 +1,111 @@
+:orphan:
+
+QUICK START
+===========
+
+define table schema
+===================
+
+.. code-block:: Python
+
+    from foxlin import Schema, Column, UniqeColumn
+
+    class MyTable(Schema):
+        name    : str = Column()
+        age     : int = Column()
+        username: str = UniqeColumn()
+
+
+initial db instance
+===================
+
+.. code-block:: Python
+
+    from foxlin import FoxLin
+
+    db_path = './db.json' # set path of database
+
+    db = FoxLin(db_path, MyTable)
+
+
+
+CRUD
+====
+.. code-block:: Python
+
+    # insert
+    data = MyTable(
+        name = 'tom',
+        age  = 17,
+        username = 'tomtom'
+    )
+
+    # insert data
+    with db.session as session:
+        session.insert(data)
+
+
+
+    data.age = 18
+    session.update(data, updated_field=['age'])
+
+
+    # delete data
+    session.delete(data.ID)
+
+
+Query
+=====
+.. code-block:: Python
+
+    # get query
+    query = session.query
+    # OR
+    query = db.query
+
+
+    # select columns
+    query.select('age','name')
+
+
+    # get first record
+    record = query.first()
+
+
+    # get end
+    record = query.end()
+
+
+    # get random record
+    record = query.rand()
+
+
+    # get all
+    records = query.select('age','username').all() # return generator
+    record_list = list(records)
+
+
+    # access column data
+    name_data = query.name
+    age_data = query.age
+
+
+    # filter records
+    filterd_rec = query.select('username').where(q.age > 50, q.name == 'some name').first()
+
+
+    # sort records
+    sorted_recs = query.where(query.age == 17).select('age').order_by(query.age).first()
+
+
+    # max, min, mean
+    query.where(query.age == 17)
+    query.order_by(query.age)
+
+    max_rec = query.max()
+    min_rec = query.min()
+    mean_rec = query.mean()
+
+
+    # limit records
+    10_rec = query.limit(10).all()