Merge pull request #249 from intelowlproject/develop

5.0.1
intelowlproject · Aug 20, 2024 · 3a4c870 · 3a4c870
2 parents 1a5ff68 + e17fd5d
commit 3a4c870
Show file tree

Hide file tree

Showing 19 changed files with 15 additions and 628 deletions.
diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
@@ -1,4 +1,7 @@
 # Changelog
+## [5.0.1](https://github.com/intelowlproject/pyintelowl/releases/tag/5.0.1)
+- Updated documentation
+- Removed old endpoints
 
 ## [5.0.0](https://github.com/intelowlproject/pyintelowl/releases/tag/5.0.0)
 - Fixes for Playbook Analysis

diff --git a/.github/release_template.md b/.github/release_template.md
@@ -1,7 +1,7 @@
 # Checklist for creating a new release
 
 - [ ] Update `CHANGELOG.md` for the new version
-- [ ] Change version number in `docs/conf.py`, `pyintelowl/version.py`
+- [ ] Change version number in `pyintelowl/version.py`
 - [ ] Verify CI Tests
 - [ ] Merge the PR to the `master` branch. **Note:** Only use "Merge and commit" as the merge strategy and not "Squash and merge". Using "Squash and merge" makes history between branches misaligned.
 

diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/README.md b/README.md
@@ -17,7 +17,6 @@ Robust Python **SDK** and **Command Line Client** for interacting with [IntelOwl
   - Choose whether you want to HTTP poll for the analysis to finish or not.
 - List all jobs or view one job in a prettified tabular form.
 - List all tags or view one tag in a prettified tabular form.
-- Tabular view of the `analyzer_config.json` and `connector_config.json` from IntelOwl with RegEx matching capabilities.
 
 ## Demo
 
@@ -51,8 +50,6 @@ Commands:
   analyzer-healthcheck   Send healthcheck request for an analyzer...
   config                 Set or view config variables
   connector-healthcheck  Send healthcheck request for a connector
-  get-analyzer-config    Get current state of `analyzer_config.json` from...
-  get-connector-config   Get current state of `connector_config.json` from...
   jobs                   Manage Jobs
   tags                   Manage tags
 ```
@@ -64,27 +61,18 @@ from pyintelowl import IntelOwl
 obj = IntelOwl("<your_api_key>", "<your_intelowl_instance_url>", "optional<path_to_pem_file>", "optional<proxies>")
 ```
 
-For more comprehensive documentation, please see https://pyintelowl.readthedocs.io/.
+For more comprehensive documentation, please see https://intelowlproject.github.io/docs/pyintelowl/.
 
 ## Changelog
 
 View [CHANGELOG.md](https://github.com/intelowlproject/pyintelowl/blob/master/.github/CHANGELOG.md).
 
-## FAQ
 
-#### Generate API key
+## How to generate an API key
 
 You need a valid API key to interact with the IntelOwl server.
-Keys should be created from the admin interface of [IntelOwl](https://github.com/intelowlproject/intelowl): you have to go in the _Durin_ section (click on `Auth tokens`) and generate a key there.
+Keys can be created from the "API access" section of the user's menu in the IntelOwl's GUI.
 
-#### Incompatibility after version 3.0
+![api_access](static/api_access.png)
 
-We did a complete rewrite of the PyIntelOwl client and CLI both for the version `3.0.0`. We very much recommend you to update to the latest version to enjoy all new features.
-
-#### (old auth method) JWT Token Authentication
-
-> this auth was available in IntelOwl versions <1.8.0 and pyintelowl versions <2.0.0
-
-From the admin interface of IntelOwl, you have to go in the _Outstanding tokens_ section and generate a token there.
-
-You can use it by pasting it into the file [api_token.txt](api_token.txt).
+Otherwise, you can create them from the Django Admin Interface of the IntelOwl application with an administration account. Section "Durin" -> "Auth tokens"
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/__init__.py b/docs/__init__.py
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/pyintelowl.rst b/docs/pyintelowl.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/serve_docs.sh b/docs/serve_docs.sh