sahim-django-common 0.1.0

Django utilities and common reusable components

sahim-django-common 📦

Django utilities and common components developed and maintained by SahimCo. This package is published publicly on PyPI for use in any Django project.

📥 Installation

Install from PyPI with pip:

pip install sahim-django-common

Or add to your project's dependencies (e.g. requirements.txt):

sahim-django-common

📋 Requirements

• Python 3.10+
• Django 5.0+

🚀 Usage

Add the app to your Django project's INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "sahim_django_common",
    # ...
]

Or with the full app config:

INSTALLED_APPS = [
    # ...
    "sahim_django_common.apps.SahimDjangoCommonConfig",
    # ...
]

After installation, follow the documentation for the specific utilities you need. Usage details will depend on which modules you use.

(Documentation for individual utilities will be added here or in the docs as the package grows.)

📦 What's included

This package provides reusable Django utilities used across SahimCo projects, such as:

• 🔧 Helper functions and decorators
• ⚡ Optional management commands and app hooks

(This section can be updated as new utilities are added.)

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.

🔧 Development

Setup

Install the package in editable mode with all dev and test dependencies:

pip install -r requirements-dev.txt

This installs the package (editable) plus pre-commit, pytest, and pytest-django.

Pre-commit

This project uses pre-commit for code quality checks:

# Install git hooks (run once)
pre-commit install

Hooks run automatically on commit. To run manually:

pre-commit run --all-files

Tests

Run tests with pytest:

pytest

📤 Publishing releases (PyPI)

Releases are published to PyPI automatically via GitHub Actions when you push a version tag.

One-time setup: Trusted Publishing on PyPI

1. Log in to PyPI and open your project’s Publishing settings:
   • https://pypi.org/manage/project/sahim-django-common/settings/publishing/
2. Add a Trusted Publisher with:
   • Owner: sahimco (or your GitHub org/user)
   • Repository name: sahim-django-common
   • Workflow name: release.yml
   • Environment name: pypi
3. Create a pypi environment in GitHub: Repo → Settings → Environments → New environment → name it pypi (Optional: enable Required reviewers for extra safety.)

Releasing a new version

1. Bump version in pyproject.toml.

2. Commit and push:

   git add pyproject.toml
   git commit -m "Release v0.1.1"
   git tag v0.1.1
   git push origin main && git push origin v0.1.1
   

3. The workflow runs automatically and publishes to PyPI.

🤝 Contributing

Contributions are welcome. Please open an issue or pull request on the GitHub repository.

---

SahimCo — GitHub · PyPI