Skip to content

Commit

Permalink
Bump version, minor readme & dependency updates
Browse files Browse the repository at this point in the history
  • Loading branch information
xtrinch committed Jul 22, 2024
1 parent 518414f commit b9f7914
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,6 @@ venv

# pytest
.pytest_cache

venv
env
12 changes: 11 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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/*`
2 changes: 1 addition & 1 deletion fcm_django/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
__author__ = "xTrinch"
__email__ = "[email protected]"
__version__ = "2.1.0"
__version__ = "2.2.1"


class NotificationError(Exception):
Expand Down
1 change: 1 addition & 0 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ isort==5.12.0
pre-commit>=2.0.0
pytest-watcher>=0.3.1
tox>=4.5.2
setuptools>=71.1.0

0 comments on commit b9f7914

Please sign in to comment.