Skip to main content

memberjojo - tools for working with members.

Project description

memberjojo

memberjojo is a Python library for using Membermojo 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.
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.


Installation

Installing via pip on macos with 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)

brew install sqlcipher
export C_INCLUDE_PATH="/opt/homebrew/opt/sqlcipher/include"
export LIBRARY_PATH="/opt/homebrew/opt/sqlcipher/lib"
pip install memberjojo

Installing via pip on ubuntu:

sudo apt-get --no-install-recommends --no-install-suggests install libsqlcipher-dev
pip install memberjojo

Or clone the repo and install locally with flit:

git clone https://github.com/a16bitsysop/memberjojo.git
cd memberjojo
flit install --symlink

Usage

Example loading members and using Member objects:

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, "My DB Password")
members.import_csv(member_csv_path)

for member in members:
    print(member.first_name, member.last_name, member.member_number)

# 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/


Running Tests

Run tests:

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.


Contact

Created and maintained by Duncan Bellamy. Feel free to open issues or reach out on GitHub.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memberjojo-2.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

memberjojo-2.2-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file memberjojo-2.2.tar.gz.

File metadata

  • Download URL: memberjojo-2.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for memberjojo-2.2.tar.gz
Algorithm Hash digest
SHA256 91cc42ed824b87c7672bd40404368d2e8e646eed4cf9212c95b684721f2e0b3b
MD5 e630c02841f8bbd07e099530c5728932
BLAKE2b-256 770cf3beb89a3f306d70e3213d0e60b9bcf8f45f7500a151b8182320cf07a6df

See more details on using hashes here.

Provenance

The following attestation bundles were made for memberjojo-2.2.tar.gz:

Publisher: publish.yaml on a16bitsysop/memberjojo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file memberjojo-2.2-py3-none-any.whl.

File metadata

  • Download URL: memberjojo-2.2-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for memberjojo-2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b6bb815a56059c02b07ddebfe5680baa111ffa4a1e816e1a03051e502b6357b
MD5 8ab801a6ff97475c22476872e5ff3b01
BLAKE2b-256 2b8abb8d08b83b6137a9818458445a4085f4e70b8bd5879c266d6e2b1e7207b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for memberjojo-2.2-py3-none-any.whl:

Publisher: publish.yaml on a16bitsysop/memberjojo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page