memberjojo 2.2__py3-none-any.whl → 3.0__py3-none-any.whl

memberjojo/url.py

@@ -0,0 +1,82 @@
+"""
+A class for managing Membermojo URLs
+"""
+
+
+class URL:
+    """A class for managing Membermojo URLs"""
+
+    def __init__(self, shortname: str):
+        """
+        Ininitalise the class
+
+        :param shortname: the shortname setting on membermojo
+        """
+        self.shortname = shortname
+        self.base_url = "https://membermojo.co.uk"
+
+    def make_url(self, endpoint: str) -> str:
+        """
+        return a whole url for endpoint
+
+        :param endpoint: the endpoint to make url for
+
+        :return: a complete url
+        """
+        return f"{self.base_url}/{self.shortname}/{endpoint}"
+
+    def members(self, state: str = "") -> str:
+        """
+        return the active, expired, or archived urls
+
+        :param state: membership state to return
+
+        :return: url for the state
+
+        state:
+            "active" or "" -> active members
+            "expired" -> expired members
+            "archived" -> archived members
+        """
+        if state not in {"", "expired", "archived"}:
+            raise ValueError(f"Invalid member state: {state}")
+
+        if state == "active":
+            state = ""
+        suffix = f"_{state}" if state else ""
+        return f"{self.membership}/download{suffix}_members"
+
+    @property
+    def login(self):
+        """Returns the membermojo login URL"""
+        return self.make_url("signin_password")
+
+    @property
+    def membership(self):
+        """Returns the URL for membership"""
+        return self.make_url("membership")
+
+    @property
+    def completed_payments(self):
+        """Returns the completed payments download URL"""
+        return f"{self.membership}/download_completed_payments?state=CO"
+
+    @property
+    def pending_aproval(self):
+        """Returns the members pending approval URL"""
+        return f"{self.membership}/download_pending_approval_members"
+
+    @property
+    def pending_completion(self):
+        """Returns the members pending completion URL"""
+        return f"{self.membership}/download_pending_completion_members"
+
+    @property
+    def pending_payments(self):
+        """Returns the members pending payments URL"""
+        return f"{self.membership}/download_pending_payments"
+
+    @property
+    def test(self):
+        """Returns the test URL for login verification"""
+        return self.membership

{memberjojo-2.2.dist-info → memberjojo-3.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: memberjojo
-Version: 2.2
+Version: 3.0
 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: sqlcipher3
 Requires-Dist: coverage ; extra == "dev"
 Requires-Dist: flit ; extra == "dev"
 Requires-Dist: pytest ; extra == "dev"
@@ -17,28 +16,34 @@ Requires-Dist: sphinx>=7.0 ; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
 Requires-Dist: black ; extra == "lint"
 Requires-Dist: pylint ; extra == "lint"
+Requires-Dist: sqlcipher3 ; extra == "sqlcipher"
 Project-URL: Home, https://github.com/a16bitsysop/memberjojo
 Provides-Extra: dev
 Provides-Extra: docs
 Provides-Extra: lint
+Provides-Extra: sqlcipher
 
 # memberjojo
 
 `memberjojo` is a Python library for using [Membermojo](http://membermojo.co.uk/)
 data from CSV imports.\
 It provides member database, and completed payments querying.\
-This is done in a local SQLite database which is encrypted, and does not alter
-anything on Membermojo.\
+This is done in a local SQLite database which is optionally encrypted if sqlcipher3
+is installed, 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 dropped before import, so you can
-just import the latest download and the local database is updated.
+just import the latest download and the local database is updated with a summary
+diff printed out.
+
+Using the download_csv function the csv can be downloaded directly into the db,
+which can also be in memory if :memory: is used as the db path.
 
 ---
 
 ## Installation
 
-Installing via `pip` on macos with `sqlcipher` installed via homebrew:\
+Installing via `pip` on macos with optional `sqlcipher` installed via homebrew:\
 (The sqlcipher bindings are compiled by pip so the `C_INCLUDE_PATH` and
 `LIBRARY_PATH` are needed for the `libsqlcipher` files to be found)
 
@@ -46,13 +51,19 @@ Installing via `pip` on macos with `sqlcipher` installed via homebrew:\
 brew install sqlcipher
 export C_INCLUDE_PATH="/opt/homebrew/opt/sqlcipher/include"
 export LIBRARY_PATH="/opt/homebrew/opt/sqlcipher/lib"
-pip install memberjojo
+pip install memberjojo[sqlciper]
 ```
 
 Installing via `pip` on ubuntu:
 
 ```bash
 sudo apt-get --no-install-recommends --no-install-suggests install libsqlcipher-dev
+pip install memberjojo[sqlcipher]
+```
+
+Installing via `pip` without sqlcipher:
+
+```bash
 pip install memberjojo
 ```
 

memberjojo-3.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+memberjojo/__init__.py,sha256=kO0EB2VTfHQFyqERL0qKRlYzAkD_cTm-b3q3uT1r91g,343
+memberjojo/_version.py,sha256=5dvh8NEGPynimE4L7R3rRJScHS-KLrDLsbEL9spnkgw,699
+memberjojo/download.py,sha256=N8s5kFm58gbOaPyWvXxRigbMk5J6vjOx4_GX--JtWFY,4387
+memberjojo/mojo_common.py,sha256=n63QPXXruOHZWIdTLFJvOBZb484KuAsHApZfg7VBDOE,12320
+memberjojo/mojo_loader.py,sha256=D8-jnNaFQ57O16drcLcAYHlLIe9-r6FKVKoTaK4Oaj4,11619
+memberjojo/mojo_member.py,sha256=UWQKJh_aEn5J1-Yb_7StijHf6JRiq2RnhMJzRos0prc,10981
+memberjojo/mojo_transaction.py,sha256=KCbhrY1Wccs_GoXHtuXgohn5MdxnUiMpKdhcVE348KU,933
+memberjojo/sql_query.py,sha256=4T6EVYZo7q0VQ2Ah6uuX20Ub_g0RsBoKs1qrZmqRK7w,185
+memberjojo/url.py,sha256=vx-l1FlrohlpAExPICU5UYRl34z_tYXvWLzGAaprdXI,2320
+memberjojo-3.0.dist-info/licenses/LICENSE,sha256=eaTLEca5OoRQ9r8GlC6Rwa1BormM3q-ppDWLFFxhQxI,1071
+memberjojo-3.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+memberjojo-3.0.dist-info/METADATA,sha256=bFOpMMpcy4A_0PwrmzousoBu9tOQzR1YRUTxycqNmMg,3964
+memberjojo-3.0.dist-info/RECORD,,

memberjojo-2.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-memberjojo/__init__.py,sha256=JGhIJ1HGbzrwzF4HsopOdP4eweLjUmFjbIDvMbk1MKI,291
-memberjojo/_version.py,sha256=_Nk5-Ctb0Jdj1fjUXI6x5dxb-FwdE56jfaBDPomGv_A,699
-memberjojo/mojo_common.py,sha256=DqJ3NKq1Lrcv8NejJFR3ZHlwZifTjqIZv6Vp0R8yOQQ,8340
-memberjojo/mojo_loader.py,sha256=pKqp7QiirThYd6gIy1LQ48GbV2DVFL0yZSLUWxuTLa0,9232
-memberjojo/mojo_member.py,sha256=3UeBIVtSXBCUpvuGN9fIJ0zgXu6vXhs4wFDHeDnOG0o,8078
-memberjojo/mojo_transaction.py,sha256=EuP_iu5R5HHCkr6PaJdWG0BP-XFMAjl-YPuCDVnKaRE,916
-memberjojo-2.2.dist-info/licenses/LICENSE,sha256=eaTLEca5OoRQ9r8GlC6Rwa1BormM3q-ppDWLFFxhQxI,1071
-memberjojo-2.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-memberjojo-2.2.dist-info/METADATA,sha256=p8d0fTLtfNk5Hir3CRwjBl5WhSYrZL4UpiokpsE0Wsk,3593
-memberjojo-2.2.dist-info/RECORD,,