Splathash
=========
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
------------
1. Install using `pip`...
.. code-block:: bash
pip install splathash
2. Add "splathash" to your INSTALLED_APPS setting like this:
.. code-block:: python
INSTALLED_APPS = [
...,
"splathash",
]
3. Include the splathash URLconf in your project urls.py like this:
.. code-block::
path("splathash/", include("splathash.urls")),
4. Run ``python manage.py migrate`` to apply migrations.
5. 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
----------------------------
1. To start contributing to **Splathash**, clone the repository's develop branch:
.. code-block:: bash
git clone -b develop https://github.com/nalo-solutions/splathash
2. Create a virtual env with all development dependencies.
.. code-block:: bash
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:
.. code-block:: bash
python manage.py runserver
4. Run the tests with:
.. code-block:: bash
pytest
Committing your code
--------------------
Before committing please make sure you have installed the `pre-commit` hooks in your local git repository:
.. code-block:: bash
pre-commit install
This will ensure that your code is cleaned before you commit it.
Creating releases
-----------------
1. 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*):
.. code-block:: bash
bump2version <part>
2. Merge new a release into main to trigger the workflow.
Raw data
{
"_id": null,
"home_page": "https://www.nalosolutions.com/",
"name": "splathash",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Nalo Solutions",
"author_email": "technicaloperations@nalosolutions.com",
"download_url": "https://files.pythonhosted.org/packages/f0/38/35262dc5912a4625e796aaab7992262f6401b9dad15f0a5c93b5cfdacadc/splathash-1.0.0.tar.gz",
"platform": null,
"description": "Splathash\n=========\n\nA Django USSD framework package.\n\nRequirements\n------------\n\n- Python 3.8+\n- Django 4.2, 4.1, 4.0, 3.2\n\nWe **highly recommend** and only officially support the latest patch release of\neach Python and Django series.\n\nInstallation\n------------\n\n1. Install using `pip`...\n\n .. code-block:: bash\n\n pip install splathash\n\n2. Add \"splathash\" to your INSTALLED_APPS setting like this:\n\n .. code-block:: python\n\n INSTALLED_APPS = [\n ...,\n \"splathash\",\n ]\n\n3. Include the splathash URLconf in your project urls.py like this:\n\n .. code-block::\n\n path(\"splathash/\", include(\"splathash.urls\")),\n\n4. Run ``python manage.py migrate`` to apply migrations.\n\n5. Start the development server and visit http://127.0.0.1:8000/splathash/playground/\n to test your USSD endpoint (you'll need to login with a user in the admin panel first).\n\nContributing and development\n----------------------------\n\n1. To start contributing to **Splathash**, clone the repository's develop branch:\n\n .. code-block:: bash\n\n git clone -b develop https://github.com/nalo-solutions/splathash\n\n2. Create a virtual env with all development dependencies.\n\n .. code-block:: bash\n\n cd splathash\n python3 -m venv venv\n source venv/bin/activate\n pip install -r requirements.txt\n\n3. 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.\nThis project is designed to facilitate testing of the `splathash` package within a Django project. To run the development server, use the following command:\n\n .. code-block:: bash\n\n python manage.py runserver\n\n4. Run the tests with:\n\n .. code-block:: bash\n\n pytest\n\nCommitting your code\n--------------------\n\nBefore committing please make sure you have installed the `pre-commit` hooks in your local git repository:\n\n.. code-block:: bash\n\n pre-commit install\n\nThis will ensure that your code is cleaned before you commit it.\n\nCreating releases\n-----------------\n\n1. 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*):\n\n .. code-block:: bash\n\n bump2version <part>\n\n2. Merge new a release into main to trigger the workflow.\n\n\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "A Django USSD Framework.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://www.nalosolutions.com/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d040dc8ed7adb139560ed801dd1f016128b3ad1968082211b01d51de4c11692c",
"md5": "9353ae8ea744810f9595fdaf9ebaf256",
"sha256": "cbf3ac697cd6705d7f35fbb46927c2598bcd2aa175ae4acf0f261a55bc7f484b"
},
"downloads": -1,
"filename": "splathash-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9353ae8ea744810f9595fdaf9ebaf256",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24744,
"upload_time": "2023-06-06T12:14:37",
"upload_time_iso_8601": "2023-06-06T12:14:37.815786Z",
"url": "https://files.pythonhosted.org/packages/d0/40/dc8ed7adb139560ed801dd1f016128b3ad1968082211b01d51de4c11692c/splathash-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f03835262dc5912a4625e796aaab7992262f6401b9dad15f0a5c93b5cfdacadc",
"md5": "faeb06a9c5034964311a762887cbae07",
"sha256": "45b70301d645909b82b900d7a96aa9a0252c35b541f77d30a21c4454b7433c4a"
},
"downloads": -1,
"filename": "splathash-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "faeb06a9c5034964311a762887cbae07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16530,
"upload_time": "2023-06-06T12:14:39",
"upload_time_iso_8601": "2023-06-06T12:14:39.438012Z",
"url": "https://files.pythonhosted.org/packages/f0/38/35262dc5912a4625e796aaab7992262f6401b9dad15f0a5c93b5cfdacadc/splathash-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 12:14:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "splathash"
}
JSON