droidoc 0.0.1__tar.gz

droidoc-0.0.1/.dockerignore

@@ -0,0 +1,8 @@
+# Ignore everything
+*
+
+# Allow files and directories
+!/droidoc/
+!/Makefile
+!/pyproject.toml
+!/README.rst

droidoc-0.0.1/.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = E203, E266, E501, W503, F403, F401
+max-line-length = 79
+max-complexity = 18
+select = B,C,E,F,W,T4,B9
+exclude = docs/source/conf.py

droidoc-0.0.1/.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.droidoc
+
+docs/build/
+
+**/tests/msap_data/

droidoc-0.0.1/.gitlab-ci.yml

@@ -0,0 +1,184 @@
+# This is a GitLab CI configuration to build the project documentaiton and the docker image
+image: docker:20
+
+stages:
+  - doc # Stage to build the documentation
+  - build # Stage to build the Docker image
+  - push # Stage to push Docker images
+  - test # Stage to test
+  - quality # Stage ofr SonarQube
+
+services:
+  -  docker:dind
+
+variables:
+    DOCKER_DRIVER: overlay2
+    DOCKER_TLS_CERTDIR: ''
+
+before_script:
+  # Authenticate Docker with GitLab registry
+  # docker login asks for the password to be passed through stdin for security
+  # we use $CI_REGISTRY_PASSWORD here which is a special variable provided by GitLab
+  # https://docs.gitlab.com/ce/ci/variables/predefined_variables.html
+  - echo "CI_JOB_TOKEN=$CI_JOB_TOKEN"
+  - echo $CI_REGISTRY_PASSWORD | docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY
+
+pages:
+  image: ubuntu
+  stage: doc
+  before_script:
+    # Install tools for installing dependencies for documentation generation
+    - TZ=Europe/Paris
+    - ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+    - DEBIAN_FRONTEND=noninteractive apt -y update
+    - DEBIAN_FRONTEND=noninteractive apt -y install plantuml git
+    - apt -y install python3-pip python3-venv curl
+    - update-alternatives --install /usr/bin/pip pip /usr/bin/pip3 1
+
+
+    # Install prerequisites for pyenv
+    - apt -y install curl git-core gcc make zlib1g-dev libssl-dev libbz2-dev libreadline-dev libsqlite3-dev libffi-dev
+    # Install pyenv
+    - curl https://pyenv.run | bash
+    - export PATH="/root/.pyenv/bin:$PATH"
+    - eval "$(pyenv init -)"
+    - eval "$(pyenv virtualenv-init -)"
+
+    # Install poetry
+    - curl -sSL https://install.python-poetry.org | python3 -
+    - export PATH=$PATH:/root/.local/bin/
+    - poetry config installer.max-workers 10
+
+  script:
+    # Install dependencies and generate documentation
+    - make prepare-dev
+    - source .droidoc
+    - make install-dev
+    - make doc
+    - mkdir public
+    - mv docs/build/html/* public
+    - ls public/*
+
+  artifacts:
+    paths:
+      - public
+
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^(\d+\.\d+\.\d+)$/
+
+Build:
+  stage: build
+  script:
+    - echo "Building $CI_REGISTRY_IMAGE"
+    # fetches the latest image (not failing if image is not found)
+    - docker pull $CI_REGISTRY_IMAGE:latest || true
+    # builds the project,
+    # notice the cache-from, which is going to use the image we just pulled locally
+    # the built image is tagged locally with the commit SHA, and then pushed to
+    # the GitLab registry
+    - >
+      docker build
+      --pull
+      --cache-from $CI_REGISTRY_IMAGE:latest
+      --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+      --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')
+      --build-arg VERSION=$CI_COMMIT_SHA
+      --build-arg CI_JOB_TOKEN=$CI_JOB_TOKEN
+      .
+    - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+
+
+# Here, the goal is to tag the "main" branch as "latest"
+Push latest:
+  variables:
+    # We are just playing with Docker here.
+    # We do not need GitLab to clone the source code.
+    GIT_STRATEGY: none
+  stage: push
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  script:
+    - echo "Create Tag latest"
+    # Because we have no guarantee that this job will be picked up by the same runner
+    # that built the image in the previous step, we pull it again locally
+    - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    # Then we tag it "latest"
+    - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:latest
+    # Annnd we push it.
+    - docker push $CI_REGISTRY_IMAGE:latest
+
+# Finally, the goal here is to Docker tag any Git tag
+# GitLab will start a new pipeline everytime a Git tag is created, which is pretty awesome
+Push tag:
+  variables:
+    # Again, we do not need the source code here. Just playing with Docker.
+    GIT_STRATEGY: none
+  stage: push
+
+  script:
+    - echo "Create Tag $CI_COMMIT_REF_NAME"
+    - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
+    - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG
+
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^(\d+\.\d+\.\d+)$/
+
+
+test:
+  image: python:3.12-slim-bullseye
+  stage: test
+  before_script:
+    - apt update && apt install --yes make git curl
+    - curl -sSL https://install.python-poetry.org | python3
+    - export PATH="/root/.local/bin:$PATH"
+    - poetry config installer.max-workers 10
+    - make prepare-dev
+    - source .droidoc
+    - make install-dev
+  artifacts:
+    expose_as: coverage report
+    paths:
+      - coverage.xml
+    when: always
+  script:
+    - make coverage
+    - make coverage_xml
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main" || $CI_COMMIT_BRANCH == "ci" || $CI_COMMIT_TAG != null
+
+sonar_qube:
+  image:
+    name: sonarsource/sonar-scanner-cli:5.0.1
+    entrypoint: ['']
+  dependencies:
+    - test
+  before_script: []
+  stage: quality
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main" || $CI_COMMIT_BRANCH == "ci" || $CI_COMMIT_TAG != null
+  script:
+    - java --version
+    - |
+      sonar-scanner \
+       -Dsonar.host.url=${SONAR_HOST_URL} \
+       -Dsonar.gitlab.commit_sha=${CI_COMMIT_SHA} \
+       -Dsonar.gitlab.project_id=${CI_PROJECT_ID} \
+       -Dsonar.gitlab.ref_name=${CI_COMMIT_REF_NAME} \
+       -Dsonar.gitlab.url=${CI_PROJECT_URL} \
+       -Dsonar.language=py \
+       -Dsonar.links.ci=${CI_PROJECT_URL}/pipelines \
+       -Dsonar.links.issue=${CI_PROJECT_URL}/-/issues \
+       -Dsonar.links.scm=${CI_PROJECT_URL} \
+       -Dsonar.login=${SONAR_TOKEN} \
+       -Dsonar.projectBaseDir=${CI_PROJECT_DIR} \
+       -Dsonar.projectKey=droidoc \
+       -Dsonar.projectName=${CI_PROJECT_NAME} \
+       -Dsonar.python.coverage.reportPaths=coverage.xml \
+       -Dsonar.sources=droidoc \
+       -Dsonar.sourceEncoding=UTF-8 \
+       -Dsonar.tests=tests \
+       -Dsonar.verbose=false

droidoc-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-xml
+      - id: check-json
+      - id: check-added-large-files
+      - id: fix-byte-order-marker
+      - id: detect-private-key
+      - id: name-tests-test
+      - id: requirements-txt-fixer
+      - id: pretty-format-json
+        exclude: ^update/cookiecutter_answers\.json$
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.19.0
+    hooks:
+      - id: reorder-python-imports
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 26.10.1
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.4.1
+    hooks:
+      - id: flake8

droidoc-0.0.1/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Dinil Bose Palakkatharappil <dinilbose@gmail.com>
+
+Contributors
+------------
+
+None yet.

droidoc-0.0.1/CHANGELOG

@@ -0,0 +1,24 @@
+### cookiecutter style applied (HEAD -> cookiecutter_style)
+>Sat, 17 Oct 2026 22:25:28 +0200
+
+>Author: dinilbose (dinilbose@gmail.com)
+
+>Commiter: dinilbose (dinilbose@gmail.com)
+
+
+### Format code with black and reorder-python-imports
+>Sat, 17 Oct 2026 22:24:54 +0200
+
+>Author: dinilbose (dinilbose@gmail.com)
+
+>Commiter: dinilbose (dinilbose@gmail.com)
+
+
+### Initial commit for cookiecutter style
+>Sat, 17 Oct 2026 22:24:12 +0200
+
+>Author: dinilbose (dinilbose@gmail.com)
+
+>Commiter: dinilbose (dinilbose@gmail.com)
+
+

droidoc-0.0.1/CONTRIBUTING.rst

@@ -0,0 +1,121 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://gitlab.com/dinilbose/droidoc/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the Gitlab issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the Gitlab issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+droidoc could always use more documentation, whether as part of the
+official droidoc docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://gitlab.com/dinilbose/droidoc/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `droidoc` for local development.
+
+1. Fork the `droidoc` repo on Gitlab.
+2. Clone your fork locally::
+
+    $ git clone https://gitlab.com/dinilbose/droidoc.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development::
+
+    $ cd droidoc/
+    $ make prepare-dev
+    $ source .droidoc/
+    $ make install-dev
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ make lint
+    $ make tests
+    $ tox
+
+
+6. Commit your changes and push your branch to Gitlab::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the Gitlab website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality in your commit message.
+
+
+Tips
+----
+
+To run a subset of tests::
+
+    $ pytest tests.test_droidoc
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed.
+Then run::
+
+    git tag -a v1.4.0 -m "my version 1.4.0"

droidoc-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2026] [-]
+
+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.