richie 2.33.1.dev19__tar.gz → 2.33.1.dev23__tar.gz

richie-2.33.1.dev23/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.2
+Name: richie
+Version: 2.33.1.dev23
+Summary: A CMS to build learning portals for open education
+Author-email: "Open FUN (France Université Numérique)" <fun.dev@fun-mooc.fr>
+License: MIT License
+        
+        Copyright (c) 2018-present GIP FUN MOOC.
+        
+        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.
+        
+        
+Project-URL: Bug Tracker, https://github.com/openfun/richie/issues/new
+Project-URL: Changelog, https://github.com/openfun/richie/blob/master/CHANGELOG.md
+Project-URL: Homepage, https://github.com/openfun/richie
+Project-URL: Repository, https://github.com/openfun/richie
+Project-URL: Documentation, https://richie.education/
+Project-URL: Demonstration website, https://demo.richie.education/
+Keywords: Django,Django-CMS,Open edX
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arrow<2
+Requires-Dist: Django<5
+Requires-Dist: djangocms-file<4
+Requires-Dist: djangocms-googlemap<3
+Requires-Dist: djangocms-link<6,>=5.0.0
+Requires-Dist: djangocms-picture<5
+Requires-Dist: djangocms-text-ckeditor<6
+Requires-Dist: djangocms-video<4
+Requires-Dist: djangorestframework<4
+Requires-Dist: django-autocomplete-light<4
+Requires-Dist: django-cms<4.0.0,>=3.11.0
+Requires-Dist: django-parler<3,>=2.3
+Requires-Dist: django-redis<6,>=4.11.0
+Requires-Dist: django-treebeard<5
+Requires-Dist: dj-pagination<3
+Requires-Dist: easy_thumbnails[svg]<3,>=2.8
+Requires-Dist: elasticsearch<7.0.0,>=6.0.0
+Requires-Dist: exrex<1
+Requires-Dist: importlib-metadata<9
+Requires-Dist: oauthlib<4,>=3.2.2
+Requires-Dist: requests<3,>=2.32.3
+Provides-Extra: dev
+Requires-Dist: bandit==1.8.2; extra == "dev"
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: pyRdfa3==3.6.4; extra == "dev"
+Requires-Dist: cssselect==1.2.0; extra == "dev"
+Requires-Dist: factory-boy==3.3.3; extra == "dev"
+Requires-Dist: flake8==7.1.1; extra == "dev"
+Requires-Dist: flake8-pyproject==1.2.3; extra == "dev"
+Requires-Dist: htmlmin==0.1.12; extra == "dev"
+Requires-Dist: ipdb==0.13.13; extra == "dev"
+Requires-Dist: ipython==8.32.0; extra == "dev"
+Requires-Dist: isort==6.0.0; extra == "dev"
+Requires-Dist: lxml==5.3.1; extra == "dev"
+Requires-Dist: msgpack==1.1.0; extra == "dev"
+Requires-Dist: mysqlclient==2.2.7; extra == "dev"
+Requires-Dist: pylint==3.3.4; extra == "dev"
+Requires-Dist: pylint-django==2.6.1; extra == "dev"
+Requires-Dist: pytest==8.3.4; extra == "dev"
+Requires-Dist: pytest-cov==6.0.0; extra == "dev"
+Requires-Dist: pytest-django==4.9.0; extra == "dev"
+Requires-Dist: responses==0.25.6; extra == "dev"
+Provides-Extra: ci
+Requires-Dist: twine==6.1.0; extra == "ci"
+Provides-Extra: sandbox
+Requires-Dist: django-configurations==2.5.1; extra == "sandbox"
+Requires-Dist: dockerflow==2024.4.2; extra == "sandbox"
+Requires-Dist: factory-boy==3.3.3; extra == "sandbox"
+Requires-Dist: gunicorn==23.0.0; extra == "sandbox"
+Requires-Dist: psycopg2-binary==2.9.10; extra == "sandbox"
+Requires-Dist: sentry-sdk==2.20.0; extra == "sandbox"
+
+# Richie, the best OpenSource CMS to build education portals
+
+[![CircleCI](https://circleci.com/gh/openfun/richie/tree/master.svg?style=svg)](https://circleci.com/gh/openfun/richie/tree/master)
+
+## Overview
+
+`Learning Management Systems` (LMS) are great tools for hosting and playing interactive online
+courses and MOOCs.
+
+However, if you need to build a complete website with flexible content to aggregate your courses,
+in several languages and from different sources, **you will soon need a CMS**.
+
+At "France Université Numérique", we wanted to build an OpenSource portal with `Python` and
+`Django`. That's why we built `Richie` on top of [DjangoCMS](https://www.django-cms.org), one of
+the best CMS on the market, as a toolbox to easily create full fledged websites with a catalog of
+online courses.
+
+Among the features that `Richie` offers out of the box:
+
+- multi-lingual by default,
+- advanced access rights and moderation,
+- catalog of courses synchronized with one or more `LMS` instances,
+- search engine based on `Elasticsearch` and pre-configured to offer full-text queries,
+  multi-facetting, auto-complete,...
+- flexible custom pages for courses, organizations, categories, teachers, blog posts,
+  programs (and their inter-relations),
+- Extensible with any third-party `DjangoCMS` plugin or any third-party `Django` application.
+
+## Discover Richie
+
+If you're looking for a quick preview of `Richie`, you can take a look and have a tour of
+`Richie` on our dedicated [demo site](https://demo.richie.education).
+
+It is connected back-to-back with a demo of OpenEdX running on
+[OpenEdX Docker](https://github.com/openfun/openedx-docker).
+
+Two users are available for testing:
+
+- admin: `admin@example.com`/`admin`
+- student: `edx@example.com`/`edx`
+
+The database is regularly flushed.
+
+## Getting started
+
+Take a look at our [documentation](https://richie.education/docs/discover) to get started with Richie.
+
+## Contributing
+
+### [Contributing guide](https://richie.education/docs/contributing-guide)
+
+Read our [contributing guide](https://richie.education/docs/contributing-guide) to learn about our development process and get started developing on `Richie`.
+
+### License
+
+This work is released under the MIT License (see [LICENSE](./LICENSE)).

richie-2.33.1.dev23/pyproject.toml

@@ -0,0 +1,140 @@
+#
+# Richie package
+#
+[build-system]
+requires = ["setuptools>=60", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "richie"
+dynamic = ["version"]
+description = "A CMS to build learning portals for open education"
+readme = "README.md"
+authors = [{ "name" = "Open FUN (France Université Numérique)", "email" = "fun.dev@fun-mooc.fr" }]
+license = { file = "LICENSE" }
+keywords = ["Django", "Django-CMS", "Open edX"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django",
+    "Framework :: Django :: 4",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "arrow<2",
+    "Django<5",
+    "djangocms-file<4",
+    "djangocms-googlemap<3",
+    "djangocms-link>=5.0.0,<6",
+    "djangocms-picture<5",
+    "djangocms-text-ckeditor<6",
+    "djangocms-video<4",
+    "djangorestframework<4",
+    "django-autocomplete-light<4",
+    "django-cms>=3.11.0,<4.0.0",
+    "django-parler>=2.3,<3",
+    "django-redis>=4.11.0,<6",
+    "django-treebeard<5",
+    "dj-pagination<3",
+    "easy_thumbnails[svg]>=2.8,<3",
+    "elasticsearch>=6.0.0,<7.0.0",
+    "exrex<1",
+    "importlib-metadata<9",
+    "oauthlib>=3.2.2,<4",
+    "requests>=2.32.3,<3",
+]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/openfun/richie/issues/new"
+"Changelog" = "https://github.com/openfun/richie/blob/master/CHANGELOG.md"
+"Homepage" = "https://github.com/openfun/richie"
+"Repository" = "https://github.com/openfun/richie"
+"Documentation" = "https://richie.education/"
+"Demonstration website" = "https://demo.richie.education/"
+
+[tool.setuptools]
+packages = { find = { where = ["src"], exclude = ["tests"] } }
+zip-safe = true
+
+[tool.distutils.bdist_wheel]
+universal = true
+
+[project.optional-dependencies]
+dev = [
+    "bandit==1.8.2",
+    "black==25.1.0",
+    "pyRdfa3==3.6.4",
+    "cssselect==1.2.0",
+    "factory-boy==3.3.3",
+    "flake8==7.1.1",
+    "flake8-pyproject==1.2.3",
+    "htmlmin==0.1.12",
+    "ipdb==0.13.13",
+    "ipython==8.32.0",
+    "isort==6.0.0",
+    "lxml==5.3.1",
+    "msgpack==1.1.0",
+    "mysqlclient==2.2.7",
+    "pylint==3.3.4",
+    "pylint-django==2.6.1",
+    "pytest==8.3.4",
+    "pytest-cov==6.0.0",
+    "pytest-django==4.9.0",
+    "responses==0.25.6",
+]
+ci = [
+    "twine==6.1.0",
+]
+sandbox = [
+    "django-configurations==2.5.1",
+    "dockerflow==2024.4.2",
+    "factory-boy==3.3.3",
+    "gunicorn==23.0.0",
+    "psycopg2-binary==2.9.10",
+    "sentry-sdk==2.20.0",
+]
+
+[tool.flake8]
+max-line-length = 99
+exclude = [
+    ".git",
+    ".venv",
+    "build",
+    "venv",
+    "__pycache__",
+    "node_modules",
+    "*/migrations/*",
+]
+
+[tool.isort]
+profile = "black"
+known_django = "django"
+known_richie = "richie"
+include_trailing_comma = true
+line_length = 88
+multi_line_output = 3
+sections = ["FUTURE","STDLIB","DJANGO","THIRDPARTY","RICHIE","FIRSTPARTY","LOCALFOLDER"]
+skip_glob = "src/frontend/node_modules/**/*,venv"
+
+[tool.pytest.ini_options]
+addopts = "-v --cov-report term-missing"
+python_files = [
+    "test_*.py",
+    "tests.py"
+]
+testpaths = [
+    "tests",
+]
+filterwarnings = [
+    "ignore:::(?!(tests|richie))",
+]
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"

richie-2.33.1.dev23/src/frontend/js/components/PaymentScheduleGrid/_styles.scss

@@ -0,0 +1,46 @@
+.payment-schedule__grid {
+  .payment-schedule__cell {
+    &--wrapped {
+      white-space: normal;
+    }
+
+    &--alignRight {
+      display: flex;
+      justify-content: flex-end;
+    }
+  }
+}
+
+.status-pill {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  height: 24px;
+  padding: 0 12px;
+  border-radius: 24px;
+  font-family: var(--c--theme--font--families--accent);
+  font-weight: var(--c--theme--font--weight--semibold);
+  font-size: rem-calc(12px);
+
+  &--canceled,
+  &--refunded {
+    color: var(--c--theme--colors--white);
+    background-color: var(--c--theme--colors--grey59);
+  }
+
+  &--paid {
+    background-color: var(--c--theme--colors--mantis);
+    color: var(--c--theme--colors--mantis-darken);
+  }
+
+  &--pending {
+    background-color: var(--c--theme--colors--denim);
+    color: var(--c--theme--colors--white);
+  }
+
+  &--refused,
+  &--error {
+    background-color: var(--c--theme--colors--firebrick6);
+    color: var(--c--theme--colors--white);
+  }
+}

richie-2.33.1.dev23/src/frontend/js/components/PaymentScheduleGrid/index.tsx

@@ -0,0 +1,109 @@
+import { DataGrid } from '@openfun/cunningham-react';
+import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
+import { StringHelper } from 'utils/StringHelper';
+import { PaymentSchedule, PaymentScheduleState } from 'types/Joanie';
+import useDateFormat from 'hooks/useDateFormat';
+
+type Props = {
+  schedule: PaymentSchedule;
+};
+
+const messages = defineMessages({
+  withdrawnAt: {
+    id: 'components.PaymentScheduleGrid.withdrawnAt',
+    defaultMessage: 'Withdrawn on {date}',
+    description: 'Label displayed to explain when the installment will be withdrawn.',
+  },
+});
+
+export const stateMessages = defineMessages({
+  [PaymentScheduleState.PENDING]: {
+    id: 'components.PaymentScheduleGrid.state.pending',
+    defaultMessage: 'Pending',
+    description: 'Label displayed for pending payment state',
+  },
+  [PaymentScheduleState.ERROR]: {
+    id: 'components.PaymentScheduleGrid.state.error',
+    defaultMessage: 'Pending',
+    description:
+      'Label displayed for error payment state. For learner we assume to display `pending`.',
+  },
+  [PaymentScheduleState.PAID]: {
+    id: 'components.PaymentScheduleGrid.state.paid',
+    defaultMessage: 'Paid',
+    description: 'Label displayed for paid payment state',
+  },
+  [PaymentScheduleState.REFUSED]: {
+    id: 'components.PaymentScheduleGrid.state.refused',
+    defaultMessage: 'Refused',
+    description: 'Label displayed for refused payment state',
+  },
+  [PaymentScheduleState.CANCELED]: {
+    id: 'components.PaymentScheduleGrid.state.canceled',
+    defaultMessage: 'Canceled',
+    description: 'Label displayed for canceled payment state',
+  },
+  [PaymentScheduleState.REFUNDED]: {
+    id: 'components.PaymentScheduleGrid.state.refunded',
+    defaultMessage: 'Refunded',
+    description: 'Label displayed for refunded payment state',
+  },
+});
+
+export const PaymentScheduleGrid = ({ schedule }: Props) => {
+  const intl = useIntl();
+  const formatDate = useDateFormat();
+
+  return (
+    <div className="payment-schedule__grid">
+      <DataGrid
+        displayHeader={false}
+        columns={[
+          { field: 'index', size: 10 },
+          { field: 'amount', size: 90 },
+          {
+            field: 'date',
+            renderCell: ({ row }) => (
+              <span className="payment-schedule__cell--wrapped">
+                <FormattedMessage {...messages.withdrawnAt} values={{ date: row.date }} />
+              </span>
+            ),
+          },
+          {
+            id: 'state',
+            renderCell: ({ row }) =>
+              row.state ? (
+                <div className="payment-schedule__cell--alignRight">
+                  <StatusPill state={row.state} />
+                </div>
+              ) : (
+                ''
+              ),
+          },
+        ]}
+        rows={schedule.map((installment, index) => ({
+          id: installment.id,
+          index: index + 1,
+          date: formatDate(installment.due_date),
+          amount: intl.formatNumber(installment.amount, {
+            style: 'currency',
+            currency: installment.currency,
+          }),
+          state: installment.state,
+        }))}
+      />
+    </div>
+  );
+};
+
+export const StatusPill = ({ state }: { state: PaymentScheduleState }) => {
+  return (
+    <span className={`status-pill status-pill--${state}`}>
+      {state in stateMessages ? (
+        <FormattedMessage {...stateMessages[state]} />
+      ) : (
+        StringHelper.capitalizeFirst(state.replace('_', ' '))
+      )}
+    </span>
+  );
+};

richie-2.33.1.dev23/src/frontend/js/hooks/useLearnerCoursesSearch/index.tsx

@@ -0,0 +1,73 @@
+import { useEffect, useState } from 'react';
+import { useSearchParams } from 'react-router';
+import { Enrollment, CredentialOrder, ProductType, CANCELED_ORDER_STATES } from 'types/Joanie';
+import { Maybe, Nullable } from 'types/utils';
+import { useOrdersEnrollments } from 'pages/DashboardCourses/useOrdersEnrollments';
+
+const useLearnerCoursesSearch = () => {
+  const [searchParams, setSearchParams] = useSearchParams();
+  const [count, setCount] = useState<Maybe<number>>();
+  const [orderAndEnrollmentList, setOrderAndEnrollmentList] = useState<
+    (CredentialOrder | Enrollment)[]
+  >([]);
+  const [isNewSearchLoading, setIsNewSearchLoading] = useState(false);
+  const query = searchParams.get('query') || undefined;
+  const {
+    data,
+    isLoading,
+    next,
+    hasMore,
+    count: currentCount,
+    error,
+  } = useOrdersEnrollments({
+    query,
+    orderFilters: {
+      product_type: [ProductType.CREDENTIAL],
+      state_exclude: CANCELED_ORDER_STATES,
+    },
+  });
+
+  useEffect(() => {
+    if (!data.length && isLoading) {
+      setIsNewSearchLoading(true);
+    }
+
+    if (isLoading) {
+      return;
+    }
+
+    if (isNewSearchLoading) {
+      setIsNewSearchLoading(false);
+    }
+
+    if (isNewSearchLoading || data.length > orderAndEnrollmentList?.length) {
+      setOrderAndEnrollmentList(data as (CredentialOrder | Enrollment)[]);
+      setCount(currentCount);
+    }
+  }, [data.length, isLoading, isNewSearchLoading, query]);
+
+  const submitSearch = (newQuery: Nullable<string>) => {
+    if (newQuery === null) {
+      searchParams.delete('query');
+    } else {
+      searchParams.set('query', newQuery);
+    }
+
+    setSearchParams(searchParams);
+    if (!newQuery) {
+      setCount(undefined);
+    }
+  };
+
+  return {
+    submitSearch,
+    data: orderAndEnrollmentList,
+    isNewSearchLoading,
+    isLoadingMore: isLoading && !isNewSearchLoading,
+    next,
+    hasMore,
+    count,
+    error,
+  };
+};
+export default useLearnerCoursesSearch;