django-my-lib 0.1.6

A handy collection of reusable Django UI components, allowing me to share and integrate elements efficiently across various projects.

django-my-lib 🚀

This project is a test for creating a Django library. 🧩

Installation 📦

You can install the library using pip or poetry:

pip install django-my-lib
# or
poetry add django-my-lib

Configuration ⚙️

Add django_my_lib to the INSTALLED_APPS list in your settings.py:

INSTALLED_APPS = [
    # ... other apps ...
    'django_my_lib',
]

Migrations 🗄️

After installing and configuring, run the following commands:

python manage.py makemigrations
python manage.py migrate

🎉 Done! Your Django library is installed and ready to use.

Running locally as a developer 🖥️

To run the Django project locally during development, follow the steps below:

git clone https://github.com/GustavoRizzo/django-my-lib.git
cd django-my-lib
poetry install
poetry run task run-demo

For a more complete setup, you can run the comands:

poetry run task migrate
poetry run task createsuperuser
# or
poetry run task setup  # that will do the same as above

Tests 🧪

To run the tests, use the command below inside the demo_project directory:

poetry run task test

Linting 🧹

To check for linting issues, use the command below:

poetry run task lint
poetry run task lint-fix  # to fix issues automatically

Updating and publishing the library 🚢

To update the version, build, and publish your library, use the commands below:

poetry version patch  # to bump the version (e.g.: 0.1.0 → 0.1.1)
poetry build
tar -tzf dist/*.tar.gz | head -20  # to see the files inside the package
poetry publish