memberjojo 1.2__tar.gz

memberjojo-1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Duncan Bellamy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

memberjojo-1.2/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: memberjojo
+Version: 1.2
+Summary: memberjojo - tools for working with members.
+Author-email: Duncan Bellamy <dunk@denkimushi.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: coverage ; extra == "dev"
+Requires-Dist: flit ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: furo ; extra == "docs"
+Requires-Dist: myst-parser>=2.0 ; extra == "docs"
+Requires-Dist: sphinx>=7.0 ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
+Requires-Dist: black ; extra == "lint"
+Requires-Dist: pylint ; extra == "lint"
+Project-URL: Home, https://github.com/a16bitsysop/memberjojo
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: lint
+
+# memberjojo
+
+`memberjojo` is a Python library for managing [Membermojo](http://membermojo.co.uk/)
+data from CSV imports.\
+It provides member database interactions, and transaction querying.\
+This is done in a local SQLite database, and does not alter anything on Membermojo.\
+It provides tools to load, and query membership and transaction data efficiently
+without having to use SQLite directly.\
+When importing CSV files existing entries are skipped, so you can just import the
+latest download and the local database is updated with new entries.\
+All the transaction data is imported into the database,
+but currently only a limited amount of member data is imported.
+
+---
+
+## Installation
+
+Install via `pip`:
+
+```bash
+pip install memberjojo
+```
+
+Or clone the repo and install locally with `flit`:
+
+```bash
+git clone https://github.com/a16bitsysop/memberjojo.git
+cd memberjojo
+flit install --symlink
+```
+
+## Usage
+
+Example loading members and using Member objects:
+
+```python
+from pathlib import Path
+from membermojo import Member
+
+# database is created if it does not exist
+member_database_path = Path(Path(__file__).parent, "database", "my-members.db")
+member_csv_path = Path("download", "members.csv")
+
+members = Member(member_database_path)
+members.import_csv(member_csv_path)
+
+for member in members:
+    print(member.first_name, member.last_name, member.member_num)
+
+# Get full name for a given member number
+found_name = members.get_name(1)
+if found_name:
+    print(f"Member with id of 1 is {found_name}")
+else:
+    print("Member 1 does not exist")
+```
+
+## Documentation
+
+Full documentation is available at  
+👉 [https://a16bitsysop.github.io/memberjojo/](https://a16bitsysop.github.io/memberjojo/)
+
+---
+
+## Running Tests
+
+Run tests:
+
+```bash
+pytest
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repo
+2. Create your feature branch `git checkout -b my-feature`
+3. Edit the source code to add and test your changes
+4. Commit your changes `git commit -m 'Add some feature'`
+5. Push to your branch `git push origin my-feature`
+6. Open a Pull Request
+
+Please follow the existing code style and write tests for new features.
+
+---
+
+## License
+
+This project is licensed under the MIT [MIT License](https://github.com/a16bitsysop/memberjojo/blob/main/LICENSE).
+
+---
+
+## Contact
+
+Created and maintained by Duncan Bellamy.
+Feel free to open issues or reach out on GitHub.
+
+---
+

memberjojo-1.2/README.md

@@ -0,0 +1,99 @@
+# memberjojo
+
+`memberjojo` is a Python library for managing [Membermojo](http://membermojo.co.uk/)
+data from CSV imports.\
+It provides member database interactions, and transaction querying.\
+This is done in a local SQLite database, and does not alter anything on Membermojo.\
+It provides tools to load, and query membership and transaction data efficiently
+without having to use SQLite directly.\
+When importing CSV files existing entries are skipped, so you can just import the
+latest download and the local database is updated with new entries.\
+All the transaction data is imported into the database,
+but currently only a limited amount of member data is imported.
+
+---
+
+## Installation
+
+Install via `pip`:
+
+```bash
+pip install memberjojo
+```
+
+Or clone the repo and install locally with `flit`:
+
+```bash
+git clone https://github.com/a16bitsysop/memberjojo.git
+cd memberjojo
+flit install --symlink
+```
+
+## Usage
+
+Example loading members and using Member objects:
+
+```python
+from pathlib import Path
+from membermojo import Member
+
+# database is created if it does not exist
+member_database_path = Path(Path(__file__).parent, "database", "my-members.db")
+member_csv_path = Path("download", "members.csv")
+
+members = Member(member_database_path)
+members.import_csv(member_csv_path)
+
+for member in members:
+    print(member.first_name, member.last_name, member.member_num)
+
+# Get full name for a given member number
+found_name = members.get_name(1)
+if found_name:
+    print(f"Member with id of 1 is {found_name}")
+else:
+    print("Member 1 does not exist")
+```
+
+## Documentation
+
+Full documentation is available at  
+👉 [https://a16bitsysop.github.io/memberjojo/](https://a16bitsysop.github.io/memberjojo/)
+
+---
+
+## Running Tests
+
+Run tests:
+
+```bash
+pytest
+```
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repo
+2. Create your feature branch `git checkout -b my-feature`
+3. Edit the source code to add and test your changes
+4. Commit your changes `git commit -m 'Add some feature'`
+5. Push to your branch `git push origin my-feature`
+6. Open a Pull Request
+
+Please follow the existing code style and write tests for new features.
+
+---
+
+## License
+
+This project is licensed under the MIT [MIT License](https://github.com/a16bitsysop/memberjojo/blob/main/LICENSE).
+
+---
+
+## Contact
+
+Created and maintained by Duncan Bellamy.
+Feel free to open issues or reach out on GitHub.
+
+---

memberjojo-1.2/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["flit_scm",]
+build-backend = "flit_scm:buildapi"
+
+[project]
+name = "memberjojo"
+authors = [{name = "Duncan Bellamy", email = "dunk@denkimushi.com"}]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+dynamic = ["version", "description"]
+requires-python = ">=3.8"
+
+[project.urls]
+Home = "https://github.com/a16bitsysop/memberjojo"
+
+[project.optional-dependencies]
+dev = [
+    "coverage",
+    "flit",
+    "pytest",
+]
+lint = [
+    "black",
+    "pylint",
+]
+docs = [
+    "furo",                       # HTML theme
+    "myst-parser>=2.0",           # For Markdown support
+    "sphinx>=7.0",
+    "sphinx-autodoc-typehints",   # For cleaner type hints in docs
+]
+
+[tool.flit.sdist]
+exclude = ["**/.DS_Store"]
+include = ["tests", "src/memberjojo/_version.py"]
+
+[tool.setuptools_scm]
+write_to = "src/memberjojo/_version.py"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.pylint.main]
+output-format = "colorized"
+verbose = true
+ignore-patterns = ["_version.py"]

memberjojo-1.2/src/memberjojo/__init__.py

@@ -0,0 +1,12 @@
+"""
+memberjojo - tools for working with members.
+"""
+
+try:
+    from ._version import version as __version__
+except ModuleNotFoundError:
+    # _version.py is written when building dist
+    __version__ = "0.0.0+local"
+
+from .mojo_member import Member, MemberData
+from .mojo_transaction import Transaction

memberjojo-1.2/src/memberjojo/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.2'
+__version_tuple__ = version_tuple = (1, 2)
+
+__commit_id__ = commit_id = 'g30b3ecb9d'

memberjojo-1.2/src/memberjojo/config.py

@@ -0,0 +1,5 @@
+"""
+Default encoding for importing CSV files
+"""
+
+CSV_ENCODING = "UTF-8"

memberjojo-1.2/src/memberjojo/mojo_common.py

@@ -0,0 +1,55 @@
+"""
+MojoSkel base class
+
+This module provides a common base class (`MojoSkel`) for other `memberjojo` modules.
+It includes helper methods for working with SQLite databases.
+"""
+
+import sqlite3
+
+
+class MojoSkel:
+    """
+    Establishes a connection to a SQLite database and provides helper methods
+    for querying tables.
+    """
+
+    def __init__(self, db_path: str, table_name: str):
+        """
+        Initialize the MojoSkel class.
+
+        Connects to the SQLite database and sets the row factory for
+        dictionary-style access to columns.
+
+        :param db_path: Path to the SQLite database file.
+        :param table_name: Name of the table to operate on, or create when importing.
+        """
+        self.conn = sqlite3.connect(db_path)
+
+        self.conn.row_factory = sqlite3.Row
+        self.cursor = self.conn.cursor()
+        self.table_name = table_name
+
+    def show_table(self, limit: int = 2):
+        """
+        Print the first few rows of the table as dictionaries.
+
+        :param limit: (optional) Number of rows to display. Defaults to 2.
+        """
+        self.cursor.execute(f'SELECT * FROM "{self.table_name}" LIMIT ?', (limit,))
+        rows = self.cursor.fetchall()
+
+        if not rows:
+            print("(No data)")
+            return
+
+        for row in rows:
+            print(dict(row))
+
+    def count(self) -> int:
+        """
+        Returns count of the number of rows in the table.
+        """
+        self.cursor.execute(f'SELECT COUNT(*) FROM "{self.table_name}"')
+        result = self.cursor.fetchone()
+        return result[0] if result else 0