sphinxcontrib-osint 0.0.2__tar.gz

sphinxcontrib_osint-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sébastien GALLET
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sphinxcontrib_osint-0.0.2/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: sphinxcontrib-osint
+Version: 0.0.2
+Summary: Manage, archive and analyze your data collected during your OSInt quest and generate a report with sphinx.
+Author-email: bibi21000 <bibi21000@gmail.com>
+Maintainer-email: bibi21000 <bibi21000@gmail.com>
+License-Expression: MIT AND (Apache-2.0 OR BSD-2-Clause)
+Project-URL: HomePage, https://github.com/bibi21000/sphinxcontrib-osint
+Project-URL: Issues, https://github.com/bibi21000/sphinxcontrib-osint/issues
+Project-URL: Changelog, https://github.com/bibi21000/sphinxcontrib-osint/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://bibi21000.github.io/sphinxcontrib-osint/
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Text Processing
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sphinx
+Requires-Dist: tldextract
+Provides-Extra: pdf
+Requires-Dist: pdfkit; extra == "pdf"
+Provides-Extra: text
+Requires-Dist: trafilatura; extra == "text"
+Requires-Dist: lxml_html_clean; extra == "text"
+Requires-Dist: deep-translator; extra == "text"
+Requires-Dist: langdetect; extra == "text"
+Provides-Extra: analyse
+Requires-Dist: nltk; extra == "analyse"
+Requires-Dist: textblob; extra == "analyse"
+Requires-Dist: spacy; extra == "analyse"
+Requires-Dist: wordcloud; extra == "analyse"
+Requires-Dist: python-iso639; extra == "analyse"
+Requires-Dist: matplotlib; extra == "analyse"
+Requires-Dist: pyfonts; extra == "analyse"
+Provides-Extra: whois
+Requires-Dist: python-whois; extra == "whois"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: coverage[toml]; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-random-order; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: sphinx-exec-code; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Dynamic: license-file
+
+# sphinxcontrib-osint
+
+Manage, archive and analyze your data collected during your OSInt quest and generate a report with sphinx.
+
+
+## Install
+
+Make venv and install
+
+```
+    python3 -m venv venv
+    ./venv/bin/pip install sphinxcontrib-osint
+```
+
+## Example
+
+Add data you grabbed to your rst file. For example, add an organization :
+
+```
+    .. osint:org:: github
+        :label: Github
+        :ident:
+        :source:
+        :url: https://github.com/
+```
+
+And another one :
+
+```
+    .. osint:org:: microsoft
+        :label: Microsoft
+        :ident:
+```
+
+And now a relation between them :
+
+```
+    .. osint:relation::
+        :label: Buy
+        :from: microsoft
+        :to: github
+        :begin: 2018-10-26
+        :source:
+        :url: https://en.wikipedia.org/wiki/GitHub#Acquisition_by_Microsoft
+```
+
+You can add organizations, identities, events and the relations between each others
+and report then in graphs, tables or csv.
+
+Look at [documentation](https://bibi21000.github.io/sphinxcontrib-osint/) for a step by step
+tutorial or jump to the [demo](https://bibi21000.github.io/sphinxcontrib-osint/example/index.html).

sphinxcontrib_osint-0.0.2/README.md

@@ -0,0 +1,36 @@
+# sphinxcontrib-osint
+
+Easely manage and represent the OSInt data you have collected with sphinx
+
+
+## Install
+
+Clone repository
+
+```
+    git clone https://github.com/bibi21000/sphinxcontrib-osint.git
+```
+
+Change to directory
+
+```
+    cd sphinxcontrib-osint
+```
+
+Make venv and install
+
+```
+    python3 -m venv venv
+    ./venv/bin/pip install .
+```
+
+## Example
+
+Build example demo
+
+```
+    cd examples
+    make html
+```
+
+Open _build/html/index.html in your favorite browser

sphinxcontrib_osint-0.0.2/docs/README.md

@@ -0,0 +1,51 @@
+# sphinxcontrib-osint
+
+Manage, archive and analyze your data collected during your OSInt quest and generate a report with sphinx.
+
+
+## Install
+
+Make venv and install
+
+```
+    python3 -m venv venv
+    ./venv/bin/pip install sphinxcontrib-osint
+```
+
+## Example
+
+Add data you grabbed to your rst file. For example, add an organization :
+
+```
+    .. osint:org:: github
+        :label: Github
+        :ident:
+        :source:
+        :url: https://github.com/
+```
+
+And another one :
+
+```
+    .. osint:org:: microsoft
+        :label: Microsoft
+        :ident:
+```
+
+And now a relation between them :
+
+```
+    .. osint:relation::
+        :label: Buy
+        :from: microsoft
+        :to: github
+        :begin: 2018-10-26
+        :source:
+        :url: https://en.wikipedia.org/wiki/GitHub#Acquisition_by_Microsoft
+```
+
+You can add organizations, identities, events and the relations between each others
+and report then in graphs, tables or csv.
+
+Look at [documentation](https://bibi21000.github.io/sphinxcontrib-osint/) for a step by step
+tutorial or jump to the [demo](https://bibi21000.github.io/sphinxcontrib-osint/example/index.html).

sphinxcontrib_osint-0.0.2/docs/conf.py

@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# import os
+# import sys
+# sys.path.append(os.path.abspath("exts"))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'sphinxcontrib-osint'
+copyright = '2025, bibi21000'
+author = 'bibi21000'
+release = '0.0.2'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx_exec_code',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+language = 'en'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'scrolls'
+html_static_path = ['_static']

sphinxcontrib_osint-0.0.2/example/conf.py

@@ -0,0 +1,83 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+sys.path.append(os.path.abspath("../sphinxcontrib"))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'quest_example'
+copyright = '2025, bibi21000'
+author = 'bibi21000'
+release = '0.0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions =[
+    'sphinx.ext.graphviz',
+    'sphinx.ext.todo',
+    'sphinxcontrib.osint',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+language = 'EN'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'bizstyle'
+html_static_path = ['_static']
+
+# -- OSInt configuration ---------------------------------------------------
+# Look at graphviz for all possible values
+# https://graphviz.org/doc/info/shapes.html#polygon
+# https://graphviz.org/doc/info/shapes.html#styles-for-nodes
+# https://graphviz.org/doc/info/colors.html
+osint_default_cats = {
+        'media' : {
+            'shape' : 'egg',
+            'style' : 'solid',
+        },
+        'financial' : {
+            'shape' : 'hexagon',
+            'style' : 'solid',
+        },
+        'other' : {
+            'shape' : 'octogon',
+            'style' : 'dashed',
+        },
+    }
+osint_org_cats = None
+osint_ident_cats = None
+osint_event_cats = None
+osint_source_cats = None
+osint_country = 'US'
+osint_local_store = 'store_local'
+osint_csv_store = 'store_csv'
+osint_emit_warnings = False
+
+osint_text_enabled = True
+osint_text_translate = 'en'
+osint_text_original = True
+
+osint_pdf_enabled = True
+os.environ["XDG_SESSION_TYPE"] = "xcb"
+
+osint_analyse_enabled = True
+osint_analyse_countries = ['UK', "United Kingdom", 'US', 'USA']
+osint_analyse_engines = ['mood', 'words', 'people', 'countries']
+osint_analyse_update = 2
+
+osint_whois_enabled = True
+
+# -- Todos configuration ---------------------------------------------------
+todo_include_todos = False
+todo_link_only = True
+todo_emit_warnings = False

sphinxcontrib_osint-0.0.2/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+name = "sphinxcontrib-osint"
+version = "0.0.2"
+requires-python = ">= 3.9"
+readme = "docs/README.md"
+description = "Manage, archive and analyze your data collected during your OSInt quest and generate a report with sphinx."
+license = "MIT AND (Apache-2.0 OR BSD-2-Clause)"
+authors = [
+  {name = "bibi21000", email = "bibi21000@gmail.com"},
+]
+maintainers = [
+  {name = "bibi21000", email = "bibi21000@gmail.com"}
+]
+dependencies = [
+  "sphinx", "tldextract",
+]
+classifiers = [
+  # https://pypi.org/classifiers/
+  # How mature is this project ?
+  "Development Status :: 4 - Beta",
+
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+  "Topic :: Internet",
+  "Topic :: Office/Business",
+  "Topic :: Text Processing",
+
+  # Specify the Python versions you support here.
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+HomePage = "https://github.com/bibi21000/sphinxcontrib-osint"
+Issues = "https://github.com/bibi21000/sphinxcontrib-osint/issues"
+Changelog = "https://github.com/bibi21000/sphinxcontrib-osint/blob/master/CHANGELOG.md"
+Documentation = "https://bibi21000.github.io/sphinxcontrib-osint/"
+
+[project.optional-dependencies]
+pdf = ['pdfkit']
+text = ['trafilatura', 'lxml_html_clean', 'deep-translator', 'langdetect']
+analyse = ['nltk', 'textblob', 'spacy', 'wordcloud', 'python-iso639', 'matplotlib', 'pyfonts']
+whois = ["python-whois"]
+dev = ["pytest", "coverage[toml]", "pytest-cov", 'pytest-mock', "pytest-random-order", "ruff"]
+doc = ["sphinx-exec-code", 'pydata-sphinx-theme']
+build = ["build", 'twine']
+
+[tool.pytest.ini_options]
+# addopts = "--cov=fernetfile --cov-report xml --junitxml=junit.xml"
+#addopts = "--cov=fernetfile --durations=0 --capture=sys --cov-report html --junitxml=junit.xml"
+addopts = "--cov=sphinxcontrib.osint --random-order"
+
+[tool.coverage.run]
+source = ['sphinxcontrib']
+omit = ['tests']
+
+[tool.coverage.paths]
+source = ['sphinxcontrib']
+
+[tool.setuptools.packages.find]
+#where = ["."]  # list of folders that contain the packages (["."] by default)
+#include = ["src"]  # package names should match these glob patterns (["*"] by default)
+exclude = ["tests", "example", "docs/conf.py"]
+#namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
+
+[project.entry-points."sphinxcontrib.osint.plugin"]
+pdf = "sphinxcontrib.osint.plugins.pdf:Pdf"
+text = "sphinxcontrib.osint.plugins.text:Text"
+analyse = "sphinxcontrib.osint.plugins.analyse:Analyse"
+whois = "sphinxcontrib.osint.plugins.whois:Whois"

sphinxcontrib_osint-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+