Merge pull request #7 from sdementen/second_working_code

Second working code

HISTORY.md

@@ -2,10 +2,31 @@ Changelog
 =========
 
 
+(unreleased)
+------------
+- During tests, path_schemas to point to tmp folder. [sdementen]
+- Use setup.cfg instead of .flake8. [sdementen]
+- Add blank in some gnucash book name for testing purposes. [sdementen]
+- Mypy fixes. [sdementen]
+- Add make CLI implemented in python. [sdementen]
+- Fix flake8 issues. [sdementen]
+- Fix linter issues. [sdementen]
+- Adapt linter to use 140 charts per line. [sdementen]
+- Remove the rename_project.yml CI action. [sdementen]
+- Add sqlacodegen_v2 as dependency. [sdementen]
+- Update setup.py with maturity and description. [sdementen]
+- Add some simple tests. [sdementen]
+- Add example in README.md. [sdementen]
+- Add first working code. [sdementen]
+- Add data folder with sample of gnucash sqlite books. [sdementen]
+- Release: version 0.1.1 🚀 [sdementen]
+
+
 0.1.1 (2024-06-24)
 ------------------
-- Release: version 0.1.1 🚀 [sdementen]
-- Clean up repo generated from template. [sdementen]
+- Release: version 0.1.1 🚀 [Sébastien de Menten]
+- Clean up repo generated from template. [Sébastien de Menten]
+- ✅ Ready to clone and code. [sdementen]
 - Initial commit. [sdementen]
 
 

Makefile

@@ -33,8 +33,8 @@ fmt:              ## Format code using black & isort.
 .PHONY: lint
 lint:             ## Run pep8, black, mypy linters.
 	$(ENV_PREFIX)flake8 piecash2/
-	$(ENV_PREFIX)black -l 79 --check piecash2/
-	$(ENV_PREFIX)black -l 79 --check tests/
+	$(ENV_PREFIX)black -l 139 --check piecash2/
+	$(ENV_PREFIX)black -l 139 --check tests/
 	$(ENV_PREFIX)mypy --ignore-missing-imports piecash2/
 
 .PHONY: test

README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/sdementen/piecash2/branch/main/graph/badge.svg?token=piecash2_token_here)](https://codecov.io/gh/sdementen/piecash2)
 [![CI](https://github.com/sdementen/piecash2/actions/workflows/main.yml/badge.svg)](https://github.com/sdementen/piecash2/actions/workflows/main.yml)
 
-piecash using sqlalchemy 2
+A python library to work with [GnuCash](https://www.gnucash.org/) books, a successor of the [piecash](https://github.com/sdementen/piecash) library, built on top of SQLAlchemy 2.
 
 ## Install it from PyPI
 
@@ -15,17 +15,17 @@ pip install piecash2
 ## Usage
 
 ```py
-from piecash2 import BaseClass
-from piecash2 import base_function
+from piecash2 import open_book
 
-BaseClass().base_method()
-base_function()
-```
+# open the gnucash book (sqlite3 file)
+Session = open_book("mybook.gnucash")
+# retrieve the module
+piecash = Session.module
 
-```bash
-$ python -m piecash2
-#or
-$ piecash2
+with Session() as session:
+    # query all accounts in the
+    for account in session.query(piecash.Account).all():
+        print(account.name)
 ```
 
 ## Development

data/README.md

@@ -0,0 +1,11 @@
+# Sample gnucash books
+
+This folder holds a set of gnucash books used for testing, examples and debugging.
+
+
+## Default empty books
+
+The following gnucash books can be used to introspect the SQL schema:
+- reference/default_2_6_21_basic.gnucash: empty gnucash books created with gnucash 2.6.21 and no specific options
+- reference/default_2_6_21_full_options.gnucash: empty gnucash books created with gnucash 2.6.21 with multiple options enabled (trading accounts, ...)
+

make.bat

@@ -0,0 +1 @@
+@py.exe make.py %*

make.py

@@ -0,0 +1,104 @@
+import os
+import shutil
+from pathlib import Path
+
+import typer
+
+os.environ["PYTHONIOENCODING"] = "utf-8"
+
+app = typer.Typer()
+
+HERE = Path(__file__).parent
+
+
+@app.command()
+def release(tag: str):
+    print(f"WARNING: This operation will create version {tag=} and push to github")
+    typer.confirm("Do you want to continue?", abort=True)
+    Path("piecash2/VERSION").write_text(tag)
+    os.system("gitchangelog > HISTORY.md")
+    os.startfile("HISTORY.md")
+    typer.confirm("Did you update the changelog?", abort=True)
+    os.system("git add piecash2/VERSION HISTORY.md")
+    os.system(f'git commit -m "release: version {tag}')
+    print(f"creating git tag : {tag}")
+    os.system(f"git tag {tag}")
+    os.system("git push -u origin HEAD --tags")
+    print("Github Actions will detect the new tag and release the new version.")
+
+
+@app.command()
+def lint():
+    """lint:             ## Run pep8, black, mypy linters."""
+    os.system("flake8 piecash2/")
+    os.system("black -l 140 --check piecash2/")
+    os.system("black -l 140 --check tests/")
+    os.system("mypy --ignore-missing-imports piecash2/")
+
+
+@app.command()
+def fmt():
+    """fmt:              ## Format code using black & isort."""
+    os.system("isort piecash2/")
+    os.system("black -l 140 piecash2/")
+    os.system("black -l 140 tests/")
+
+
+@app.command()
+def docs():
+    """fmt:              ## Format code using black & isort."""
+    os.system("mkdocs build")
+    os.startfile(Path(__file__).parent / "site" / "index.html")
+
+
+@app.command()
+def clean():
+    """clean:            ## Clean up unused files."""
+    patterns = [
+        "**/*.pyc",
+        "**/__pycache__",
+        "**/Thumbs.db",
+        "**/*~",
+        ".cache",
+        ".pytest_cache",
+        ".mypy_cache",
+        ".tox",
+        "build",
+        "dist",
+        "*.egg-info",
+        "htmlcov",
+        "docs/_build",
+    ]
+
+    for fp in patterns:
+        for f in HERE.glob(fp):
+            if f.is_file():
+                f.unlink()
+            else:
+                shutil.rmtree(f)
+
+
+@app.command()
+def test():
+    """test:             ## Run tests and generate coverage report."""
+    os.system("pytest -v --cov-config .coveragerc --cov=piecash2 -l --tb=short --maxfail=1 tests/")
+    os.system("coverage xml")
+    os.system("coverage html")
+    os.startfile(HERE / "htmlcov" / "index.html")
+
+
+@app.command()
+def schema():
+    """schema:           ## Generate the schema from the sqlite database using sqlacodegen."""
+    import piecash2.schema.generation.schema_generation as schema_generation
+    import piecash2.schema.generated as generated
+
+    schema_generation.path_schemas = Path(generated.__file__).parent
+
+    print(f"Generating schemas in {schema_generation.path_schemas}")
+    for book in (HERE / "data").glob("*.gnucash"):
+        schema_generation.generate_schema(book, schema_generation.get_schema_name(book))
+
+
+if __name__ == "__main__":
+    app()

piecash2/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

piecash2/__init__.py

@@ -0,0 +1,5 @@
+from piecash2.schema.generation.schema_generation import add_book_module_in_path
+
+from .core.book import open_book
+
+__ALL__ = [open_book, add_book_module_in_path]

piecash2/core/book.py

@@ -0,0 +1,33 @@
+import sqlite3
+from pathlib import Path
+
+import sqlalchemy
+import sqlalchemy.orm
+
+from piecash2.schema.generation.schema_generation import import_gnucash
+
+
+def open_book(book, regenerate_schema=False):
+    if isinstance(book, str):
+        book = Path(book)
+
+    book_posix = book.as_posix()
+
+    # make a backup of the DB in memory
+    db_memory_name = f":memgeco_{abs(hash(book_posix))}:"
+    with sqlite3.connect(book_posix) as source:
+        sqliteconn = f"file:{db_memory_name}?mode=memory&cache=shared"
+        dest = sqlite3.connect(sqliteconn, uri=True)
+        source.backup(dest)
+
+    engine = sqlalchemy.create_engine(f"sqlite:///{db_memory_name}", echo=False, creator=lambda: sqlite3.connect(sqliteconn, uri=True))
+
+    Session = sqlalchemy.orm.sessionmaker(bind=engine, autoflush=True, autocommit=False)
+
+    # must execute some query otherwise future call to the Session raise error
+    with Session() as s:
+        s.execute(sqlalchemy.text(""))
+
+    Session.module = import_gnucash(book, regenerate_schema=regenerate_schema)
+
+    return Session

piecash2/schema/generation/sa_schema_post.py

@@ -0,0 +1,4 @@
+# mypy: ignore-errors
+# list all glasses with a guid property (that can be linked to in Slot/Recurrence through obj_guid)
+gl = globals()
+name2kls = {n: gl[n] for n in klswithguid_names}  # noqa: F821