Merge tag 'v0.5.0' into develop

v0.5.0

BREAKING CHANGES:

- Turn 'essid_generators' into a private attribute

Enhancements:

- Update gitignore
- Add type hints
- Update faker requirement from <14.0,>=4.1 to >=4.1,<34.0
- Run Ruff linter and formatter on all files
- Add '--fix' argument to 'ruff' pre-commit hook
- Add 'ruff-format' pre-commit hook
- Update pre-commit hooks
- Remove isort pre-commit hook
- Replace isort with Ruff
- Add support for Python 3.11, 3.12 and 3.13
- Drop support for Python 3.7 and 3.8
- Replace 'setup.cfg' with 'pyproject.toml'
- Replace Pylint and Flake8 with Ruff
- Remove 'requirements.txt'
- Replace 'assertTrue' with 'assertIn'

Fixes:

- Fix Sphinx configuration with Python 3.12
- Fix formatting issues

Documentation:

- Update readme
- Update copyright year range
- Update installation instructions
- Reorganise documentation pages
- Update instructions related to 'setup.cfg'
- Use dynamic copyright range in Sphinx doc
- Add 'Development' section to documentation

Infrastructure:

- Use latest images in CI workflows
- Add CodeQL workflow for GitHub code scanning

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2022 Paul-Emmanuel Raoul <[email protected]>
+Copyright (c) 2018-2024 Paul-Emmanuel Raoul <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -2,8 +2,7 @@
 Faker Wi-Fi ESSID
 =================
 
-|PyPI Package| |PyPI Downloads| |PyPI Python Versions| |Build Status| |LGTM
-Grade| |LGTM Alerts|
+|PyPI Package| |PyPI Downloads| |PyPI Python Versions| |Build Status|
 
 `Faker <https://github.com/joke2k/faker/>`__ provider for Wi-Fi ESSIDs.
 
@@ -32,20 +31,12 @@ Usage
 License
 =======
 
-`MIT <https://opensource.org/licenses/MIT>`__
+This project is `MIT <https://opensource.org/license/MIT>`__ licensed.
 
 .. |Build Status| image:: https://github.com/SkypLabs/faker-wifi-essid/actions/workflows/test_and_publish.yml/badge.svg?branch=develop
    :target: https://github.com/SkypLabs/faker-wifi-essid/actions/workflows/test_and_publish.yml?query=branch%3Adevelop
    :alt: Build Status
 
-.. |LGTM Alerts| image:: https://img.shields.io/lgtm/alerts/g/SkypLabs/faker-wifi-essid.svg?logo=lgtm&logoWidth=18
-   :target: https://lgtm.com/projects/g/SkypLabs/fake-wifi-essid/alerts/
-   :alt: LGTM Alerts
-
-.. |LGTM Grade| image:: https://img.shields.io/lgtm/grade/python/g/SkypLabs/faker-wifi-essid.svg?logo=lgtm&logoWidth=18
-   :target: https://lgtm.com/projects/g/SkypLabs/faker-wifi-essid/context:python
-   :alt: LGTM Grade
-
 .. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/faker-wifi-essid.svg?style=flat
    :target: https://pypi.org/project/faker-wifi-essid/
    :alt: PyPI Package Downloads Per Month

src/faker_wifi_essid/__init__.py

@@ -6,7 +6,7 @@
 
 from .wifi_essid import WifiESSID
 
-__version__ = "0.4.1"
+__version__ = "0.5.0"
 
 __all__ = [
     "WifiESSID",