Merge pull request #3 from Zeit-Labs/shadinaif/init-dashboard-module

feat: initialize dashboard module

.coveragerc

@@ -1,7 +1,7 @@
 [run]
 branch = True
 data_file = .coverage
-source=futurex_edx_extensions
+source=futurex_openedx_extensions
 omit =
     test_settings.py
     */migrations/*

.gitignore

@@ -57,8 +57,8 @@ output/*/index.html
 # Sphinx
 docs/_build
 docs/modules.rst
-docs/futurex_edx_extensions.rst
-docs/futurex_edx_extensions.*.rst
+docs/futurex_openedx_extensions.rst
+docs/futurex_openedx_extensions.*.rst
 
 # Private requirements
 requirements/private.in

CHANGELOG.rst

@@ -2,7 +2,7 @@ Change Log
 ##########
 
 ..
-   All enhancements and patches to futurex_edx_extensions will be documented
+   All enhancements and patches to futurex_openedx_extensions will be documented
    in this file.  It adheres to the structure of https://keepachangelog.com/ ,
    but in reStructuredText instead of Markdown (for ease of incorporation into
    Sphinx documentation and the PyPI description).

MANIFEST.in

@@ -3,4 +3,4 @@ include LICENSE.txt
 include README.rst
 include requirements/base.in
 include requirements/constraints.txt
-recursive-include futurex_edx_extensions *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg
+recursive-include futurex_openedx_extensions *.html *.png *.gif *.js *.css *.jpg *.jpeg *.svg

Makefile

@@ -56,9 +56,6 @@ upgrade: ## update the requirements/*.txt files with the latest packages satisfy
 quality: ## check coding style with pycodestyle and pylint
 	tox -e quality
 
-pii_check: ## check for PII annotations on all Django models
-	tox -e pii_check
-
 piptools: ## install pinned version of pip-compile and pip-sync
 	pip install -r requirements/pip.txt
 	pip install -r requirements/pip-tools.txt
@@ -72,9 +69,8 @@ test: clean ## run tests in the current virtualenv
 diff_cover: test ## find diff lines that need test coverage
 	diff-cover coverage.xml
 
-test-all: quality pii_check ## run tests on every supported Python/Django combination
+test-all: quality ## run tests on every supported Python/Django combination
 	tox
-	tox -e docs
 
 validate: quality pii_check test ## run tests and quality checks
 
@@ -85,22 +81,22 @@ selfcheck: ## check that the Makefile is well-formed
 
 extract_translations: ## extract strings to be translated, outputting .mo files
 	rm -rf docs/_build
-	cd futurex_edx_extensions && i18n_tool extract --no-segment
+	cd futurex_openedx_extensions && i18n_tool extract --no-segment
 
 compile_translations: ## compile translation files, outputting .po files for each supported language
-	cd futurex_edx_extensions && i18n_tool generate
+	cd futurex_openedx_extensions && i18n_tool generate
 
 detect_changed_source_translations:
-	cd futurex_edx_extensions && i18n_tool changed
+	cd futurex_openedx_extensions && i18n_tool changed
 
 ifeq ($(OPENEDX_ATLAS_PULL),)
 pull_translations: ## Pull translations from Transifex
 	tx pull -t -a -f --mode reviewed --minimum-perc=1
 else
 # Experimental: OEP-58 Pulls translations using atlas
 pull_translations:
-	find futurex_edx_extensions/conf/locale -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
-	atlas pull $(OPENEDX_ATLAS_ARGS) translations/futurex-edx-extensions/futurex_edx_extensions/conf/locale:futurex_edx_extensions/conf/locale
+	find futurex_openedx_extensions/conf/locale -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
+	atlas pull $(OPENEDX_ATLAS_ARGS) translations/futurex-openedx-extensions/futurex_openedx_extensions/conf/locale:futurex_openedx_extensions/conf/locale
 	python manage.py compilemessages
 
 	@echo "Translations have been pulled via Atlas and compiled."
@@ -110,7 +106,7 @@ push_translations: ## push source translation files (.po) from Transifex
 	tx push -s
 
 dummy_translations: ## generate dummy translation (.po) files
-	cd futurex_edx_extensions && i18n_tool dummy
+	cd futurex_openedx_extensions && i18n_tool dummy
 
 build_dummy_translations: extract_translations dummy_translations compile_translations ## generate and compile dummy translation files
 

README.md

@@ -1 +1 @@
-# futurex-edx-extensions
+# futurex-openedx-extensions

README.rst

@@ -1,4 +1,4 @@
-futurex-edx-extensions
+futurex-openedx-extensions
 #############################
 
 .. note::
@@ -35,7 +35,7 @@ commands? Is there a larger how-to that should be linked here?
 
 PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_
 
-.. _deployment how-to: https://docs.openedx.org/projects/futurex-edx-extensions/how-tos/how-to-deploy-this-component.html
+.. _deployment how-to: https://docs.openedx.org/projects/futurex-openedx-extensions/how-tos/how-to-deploy-this-component.html
 
 Getting Help
 ************
@@ -45,7 +45,7 @@ Documentation
 
 PLACEHOLDER: Start by going through `the documentation`_.  If you need more help see below.
 
-.. _the documentation: https://docs.openedx.org/projects/futurex-edx-extensions
+.. _the documentation: https://docs.openedx.org/projects/futurex-openedx-extensions
 
 (TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
 
@@ -63,7 +63,7 @@ For anything non-trivial, the best path is to open an issue in this
 repository with as many details about the issue you are facing as you
 can provide.
 
-https://github.com/futurex/futurex-edx-extensions/issues
+https://github.com/futurex/futurex-openedx-extensions/issues
 
 For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.
 
@@ -105,35 +105,35 @@ The assigned maintainers for this component and other project details may be
 found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
 file in this repo.
 
-.. _Backstage: https://backstage.openedx.org/catalog/default/component/futurex-edx-extensions
+.. _Backstage: https://backstage.openedx.org/catalog/default/component/futurex-openedx-extensions
 
 Reporting Security Issues
 *************************
 
 Please do not report security issues in public. Please email [email protected].
 
-.. |pypi-badge| image:: https://img.shields.io/pypi/v/futurex-edx-extensions.svg
-    :target: https://pypi.python.org/pypi/futurex-edx-extensions/
+.. |pypi-badge| image:: https://img.shields.io/pypi/v/futurex-openedx-extensions.svg
+    :target: https://pypi.python.org/pypi/futurex-openedx-extensions/
     :alt: PyPI
 
-.. |ci-badge| image:: https://github.com/futurex/futurex-edx-extensions/workflows/Python%20CI/badge.svg?branch=main
-    :target: https://github.com/futurex/futurex-edx-extensions/actions
+.. |ci-badge| image:: https://github.com/futurex/futurex-openedx-extensions/workflows/Python%20CI/badge.svg?branch=main
+    :target: https://github.com/futurex/futurex-openedx-extensions/actions
     :alt: CI
 
-.. |codecov-badge| image:: https://codecov.io/github/futurex/futurex-edx-extensions/coverage.svg?branch=main
-    :target: https://codecov.io/github/futurex/futurex-edx-extensions?branch=main
+.. |codecov-badge| image:: https://codecov.io/github/futurex/futurex-openedx-extensions/coverage.svg?branch=main
+    :target: https://codecov.io/github/futurex/futurex-openedx-extensions?branch=main
     :alt: Codecov
 
-.. |doc-badge| image:: https://readthedocs.org/projects/futurex-edx-extensions/badge/?version=latest
-    :target: https://docs.openedx.org/projects/futurex-edx-extensions
+.. |doc-badge| image:: https://readthedocs.org/projects/futurex-openedx-extensions/badge/?version=latest
+    :target: https://docs.openedx.org/projects/futurex-openedx-extensions
     :alt: Documentation
 
-.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/futurex-edx-extensions.svg
-    :target: https://pypi.python.org/pypi/futurex-edx-extensions/
+.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/futurex-openedx-extensions.svg
+    :target: https://pypi.python.org/pypi/futurex-openedx-extensions/
     :alt: Supported Python versions
 
-.. |license-badge| image:: https://img.shields.io/github/license/futurex/futurex-edx-extensions.svg
-    :target: https://github.com/futurex/futurex-edx-extensions/blob/main/LICENSE.txt
+.. |license-badge| image:: https://img.shields.io/github/license/futurex/futurex-openedx-extensions.svg
+    :target: https://github.com/futurex/futurex-openedx-extensions/blob/main/LICENSE.txt
     :alt: License
 
 .. TODO: Choose one of the statuses below and remove the other status-badge lines.

catalog-info.yaml

@@ -4,7 +4,7 @@
 apiVersion: backstage.io/v1alpha1
 kind: ""
 metadata:
-  name: 'futurex-edx-extensions'
+  name: 'futurex-openedx-extensions'
   description: "One-line description for README and other doc files."
   annotations:
     # (Optional) Annotation keys and values can be whatever you want.

docs/Makefile

@@ -96,9 +96,9 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/futurex-edx-extensions.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/futurex-openedx-extensions.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/futurex-edx-extensions.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/futurex-openedx-extensions.qhc"
 
 .PHONY: applehelp
 applehelp:
@@ -115,8 +115,8 @@ devhelp:
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/futurex-edx-extensions"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/futurex-edx-extensions"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/futurex-openedx-extensions"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/futurex-openedx-extensions"
 	@echo "# devhelp"
 
 .PHONY: epub

docs/conf.py

@@ -1,6 +1,6 @@
 # pylint: disable=invalid-name
 """
-futurex-edx-extensions documentation build configuration file.
+futurex-openedx-extensions documentation build configuration file.
 
 This file is execfile()d with the current directory set to its
 containing dir.
@@ -39,7 +39,7 @@ def get_version(*file_paths):
 REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 sys.path.append(REPO_ROOT)
 
-VERSION = get_version('../futurex_edx_extensions', '__init__.py')
+VERSION = get_version('../futurex_openedx_extensions', '__init__.py')
 # Configure Django for autodoc usage
 os.environ['DJANGO_SETTINGS_MODULE'] = 'test_settings'
 django_setup()
@@ -91,17 +91,17 @@ def get_version(*file_paths):
 top_level_doc = 'index'
 
 # General information about the project.
-project = 'futurex-edx-extensions'
+project = 'futurex-openedx-extensions'
 copyright = f'{datetime.now().year}, Axim Collaborative, Inc.'  # pylint: disable=redefined-builtin
 author = 'Axim Collaborative, Inc.'
-project_title = 'futurex-edx-extensions'
+project_title = 'futurex-openedx-extensions'
 documentation_title = f"{project_title}"
 
 # Set display_github to False if you don't want "edit on Github" button
 html_context = {
     "display_github": True,  # Integrate GitHub
     "github_user": "edx",  # Username
-    "github_repo": 'futurex-edx-extensions',  # Repo name
+    "github_repo": 'futurex-openedx-extensions',  # Repo name
     "github_version": "main",  # Version
     "conf_py_path": "/docs/",  # Path in the checkout to the docs root
 }
@@ -186,7 +186,7 @@ def get_version(*file_paths):
 # documentation.
 #
 html_theme_options = {
-    "repository_url": "https://github.com/futurex/futurex-edx-extensions",
+    "repository_url": "https://github.com/futurex/futurex-openedx-extensions",
     "repository_branch": 'main',
     "path_to_docs": "docs/",
     "home_page_in_toc": True,
@@ -223,7 +223,7 @@ def get_version(*file_paths):
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = 'futurex-edx-extensions v0.1.0'
+# html_title = 'futurex-openedx-extensions v0.1.0'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -537,8 +537,8 @@ def on_init(app):  # pylint: disable=unused-argument
         # If we are, assemble the path manually
         bin_path = os.path.abspath(os.path.join(sys.prefix, 'bin'))
         apidoc_path = os.path.join(bin_path, apidoc_path)
-    check_call([apidoc_path, '-o', docs_path, os.path.join(root_path, 'futurex_edx_extensions'),
-                os.path.join(root_path, 'futurex_edx_extensions/migrations')])
+    check_call([apidoc_path, '-o', docs_path, os.path.join(root_path, 'futurex_openedx_extensions'),
+                os.path.join(root_path, 'futurex_openedx_extensions/migrations')])
 
 
 def setup(app):

docs/index.rst

@@ -1,9 +1,9 @@
-.. futurex-edx-extensions documentation top level file, created by
+.. futurex-openedx-extensions documentation top level file, created by
    sphinx-quickstart on Tue Mar 05 09:34:19 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-futurex-edx-extensions
+futurex-openedx-extensions
 ======================
 
 One-line description for README and other doc files.

docs/make.bat

@@ -129,9 +129,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\futurex-edx-extensions.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\futurex-openedx-extensions.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\futurex-edx-extensions.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\futurex-openedx-extensions.ghc
 	goto end
 )
 

docs/testing.rst

@@ -3,7 +3,7 @@
 Testing
 #######
 
-futurex-edx-extensions has an assortment of test cases and code quality
+futurex-openedx-extensions has an assortment of test cases and code quality
 checks to catch potential problems during development.  To run them all in the
 version of Python you chose for your virtualenv:
 

futurex_openedx_extensions/__init__.py

@@ -0,0 +1,3 @@
+"""One-line description for README and other doc files."""
+
+__version__ = '0.1.0'