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

Install via pip:

Installing via pip on macos with sqlcipher installed via homebrew:
(The sqlcipher bindings are compiled by pip so the C_INCLUDE_PATH is needed for 'clang' to be able to find the header files)\

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.0.tar.gz (13.2 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.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for memberjojo-2.0.tar.gz
Algorithm Hash digest
SHA256 0f695eaba991c5992f6b41c35ba14bc85c91f6809afd4a39810fa10a52ef97a2
MD5 7179a7657287407efac930bade5e6d0d
BLAKE2b-256 eaa82fbe3f7d6a2f0bea5411fb320852ba50b32f3eb3cb41198144fdab628d22

See more details on using hashes here.

Provenance

The following attestation bundles were made for memberjojo-2.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: memberjojo-2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb53813e7f78acd57ebb1bb0e289eaba6c3c74d09fd339863a0e5867b6c5145f
MD5 77295987a0dc0367858576c9707cf70b
BLAKE2b-256 606003671e850ee6c49cb6ec7a410dddcc08bfb6ec2275e3146e557ff34ff6b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for memberjojo-2.0-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