diff --git a/.gitignore b/.gitignore index 1fec208..9d6f7e5 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,6 @@ venv # pytest .pytest_cache + +venv +env diff --git a/README.rst b/README.rst index dfa52c1..2e8a016 100644 --- a/README.rst +++ b/README.rst @@ -473,7 +473,11 @@ Submit an issue/PR on this project. Please do not send me emails, as then the co Contributing ------------ -To setup the development environment, simply do ``pip install -r requirements_dev.txt`` +To setup the development environment: + - create virtual environment with `python3 -m venv env` + - activate virtual environment with `source env/bin/activate` or `.\env\Scripts\activate.ps1` for Windows' Powershell + - run ``pip install -r requirements_dev.txt`` + To manually run the pre-commit hook, run `pre-commit run --all-files`. Because there's possibility to use swapped models therefore tests contains two config files: @@ -489,3 +493,9 @@ To run tests locally you could use ``pytest``, and if you need to check migratio export DJANGO_SETTINGS_MODULE=tests.settings.default # or export DJANGO_SETTINGS_MODULE=tests.settings.swap pytest + +Packaging for PyPi + +- run `rm -rf dist/` +- run `python3 setup.py sdist` +- run `twine upload dist/*` diff --git a/fcm_django/__init__.py b/fcm_django/__init__.py index 2cb8bb2..dd82218 100644 --- a/fcm_django/__init__.py +++ b/fcm_django/__init__.py @@ -1,6 +1,6 @@ __author__ = "xTrinch" __email__ = "mojca.rojko@gmail.com" -__version__ = "2.1.0" +__version__ = "2.2.1" class NotificationError(Exception): diff --git a/requirements_dev.txt b/requirements_dev.txt index a5aa8f4..6962ad2 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -4,4 +4,5 @@ black==24.3.0 isort==5.12.0 pre-commit>=2.0.0 pytest-watcher>=0.3.1 +setuptools>=71.1.0 tox>=4.5.2