splathash 1.0.0

Description:

splathash 1.0.0

A Django USSD framework package.

Requirements

Python 3.8+
Django 4.2, 4.1, 4.0, 3.2

We highly recommend and only officially support the latest patch release of
each Python and Django series.


Installation

Install using pip…

pip install splathash


Add “splathash” to your INSTALLED_APPS setting like this:

INSTALLED_APPS = [
...,
"splathash",
]


Include the splathash URLconf in your project urls.py like this:

path("splathash/", include("splathash.urls")),


Run python manage.py migrate to apply migrations.
Start the development server and visit http://127.0.0.1:8000/splathash/playground/
to test your USSD endpoint (you’ll need to login with a user in the admin panel first).



Contributing and development

To start contributing to Splathash, clone the repository’s develop branch:

git clone -b develop https://github.com/nalo-solutions/splathash


Create a virtual env with all development dependencies.

cd splathash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt



3. In the main project directory, you’ll find the splathash folder, which serves as both the main package itself and a Django app within the testproject Django project. Additionally, the testapp is another Django app within the testproject setup.
This project is designed to facilitate testing of the splathash package within a Django project. To run the development server, use the following command:

python manage.py runserver


Run the tests with:

pytest





Committing your code
Before committing please make sure you have installed the pre-commit hooks in your local git repository:
pre-commit install
This will ensure that your code is cleaned before you commit it.


Creating releases

Update the version number with this command(Replace <part> with the part of the version you want to increment. For example: patch, minor or major):

bump2version <part>


Merge new a release into main to trigger the workflow.