Merge pull request #43 from opbot-xd/update-greedybear-docs-ruff-migration

docs(GreedyBear): Update for Ruff migration and expand API documentation

Author: mlodic

docs/GreedyBear/Api-docs.md

@@ -1,5 +1,7 @@
 # API Documentation
 
+## API Endpoints
+
 ### `Enrichment`
 :::docs.Submodules.GreedyBear.api.views.enrichment.enrichment_view
 
@@ -12,13 +14,44 @@
 ### `Feeds Pagination`
 :::docs.Submodules.GreedyBear.api.views.feeds.feeds_pagination
 
+### `Cowrie Session`
+:::docs.Submodules.GreedyBear.api.views.cowrie_session.cowrie_session_view
+
 ### `Command Sequence`
 :::docs.Submodules.GreedyBear.api.views.command_sequence.command_sequence_view
 
-### `general_honeypot_list`
+### `General Honeypot List`
 :::docs.Submodules.GreedyBear.api.views.general_honeypot.general_honeypot_list
 
 ### `Statistics`
 :::docs.Submodules.GreedyBear.api.views.statistics.StatisticsViewSet
 
+## Serializers
+
+### `EnrichmentSerializer`
+:::docs.Submodules.GreedyBear.api.serializers.EnrichmentSerializer
+
+### `FeedsRequestSerializer`
+:::docs.Submodules.GreedyBear.api.serializers.FeedsRequestSerializer
+
+_Note: Enhanced with additional filter fields (ioc_type, etc.) in version > 2.4.0_
+
+### `FeedsResponseSerializer`
+:::docs.Submodules.GreedyBear.api.serializers.FeedsResponseSerializer
+
+### `IOCSerializer`
+:::docs.Submodules.GreedyBear.api.serializers.IOCSerializer
+
+_Note: Includes FireHol categories field in version > 2.4.0_
+
+### `GeneralHoneypotSerializer`
+:::docs.Submodules.GreedyBear.api.serializers.GeneralHoneypotSerializer
+
+## Validation Functions
+
+### `feed_type_validation`
+:::docs.Submodules.GreedyBear.api.serializers.feed_type_validation
+
+### `ordering_validation`
+:::docs.Submodules.GreedyBear.api.serializers.ordering_validation
 

docs/GreedyBear/Contribute.md

@@ -22,7 +22,17 @@ For this reason it is important to follow some easy rules based on a simple but
 
 ## Code Style
 
-Keeping to a consistent code style throughout the project makes it easier to contribute and collaborate. We make use of [`psf/black`](https://github.com/psf/black) and [isort](https://pycqa.github.io/isort/) for code formatting and [`flake8`](https://flake8.pycqa.org) for style guides.
+Keeping to a consistent code style throughout the project makes it easier to contribute and collaborate. We use [Ruff](https://docs.astral.sh/ruff/) as our all-in-one linter and formatter, which provides:
+
+- **Code Formatting**: Replaces `black` with fast, compatible formatting
+- **Import Sorting**: Replaces `isort` with automatic import organization
+- **Linting**: Replaces `flake8` with 100+ rule sets including:
+  - pycodestyle (E/W) - PEP 8 style enforcement
+  - pep8-naming (N) - Naming convention checks
+  - pyupgrade (UP) - Modern Python syntax suggestions
+  - flake8-bugbear (B) - Common bug detection
+  - flake8-comprehensions (C4) - List/dict comprehension improvements
+  - flake8-django (DJ) - Django-specific best practices
 
 ## How to start (Setup project and development instance)
 
@@ -43,6 +53,18 @@ pip install pre-commit
 pre-commit install -c .github/.pre-commit-config.yaml
 ```
 
+Once configured, Ruff will automatically run on every commit. If you want to manually run Ruff before committing, you can use:
+
+```bash
+# Format and fix auto-fixable issues
+pre-commit run ruff --all-files
+
+# Or run Ruff directly (requires: pip install ruff)
+ruff check .           # Check for linting issues
+ruff check . --fix     # Auto-fix issues
+ruff format .          # Format code
+```
+
 Remember that whenever you make changes, you need to rebuild the docker image to see the reflected changes.
 
 ```bash