Restructure, format and linting

giorgiopizz · Feb 9, 2024 · 5c9f1b8 · 5c9f1b8
1 parent e77462e
commit 5c9f1b8
Show file tree

Hide file tree

Showing 9 changed files with 423 additions and 485 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ mkShapesRDF/processor/data/jsonpog*
 start.sh
 *build*
 *html*
+.DS*
diff --git a/check_condor/check_condor_status.py b/check_condor/check_condor_status.py
diff --git a/docs/development/index.rst b/docs/development/index.rst
@@ -9,11 +9,20 @@ Linting and formatting
 
 We use ``black`` for formatting and ``flake8`` for linting.
 
+In order to have black and flake8 available you have to install with ``python3 -m pip install -e ".[dev]"``.
+
 You should run the formatting and the linting before committing your code, checking for errors/warnings and fixing them.
 
 This is very important since the CI/CD pipeline will fail if the code is not formatted or if there are linting errors.
 
 
+In ``mkShapesRDF`` folder you can run: 
+
+Formatting: ``python3 -m black --config pyproject.toml .``
+
+Linting: ``python3 -m flake8 --config setup.cfg .``
+
+
 Running tests 
 -------------
 
@@ -57,4 +66,5 @@ Docs
 In order to build the documentation you can run the command below in the root directory of mkShapesRDF:
 
 .. code:: bash
+ 
  python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs test_html