https://github.com/fccn/nau-openedx-extensions
https://github.com/fccn/nau-openedx-extensions
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fccn/nau-openedx-extensions
- Owner: fccn
- Created: 2021-05-11T14:08:24.000Z (about 5 years ago)
- Default Branch: nau/redwood.master
- Last Pushed: 2026-02-09T22:59:54.000Z (4 months ago)
- Last Synced: 2026-02-10T02:42:49.143Z (4 months ago)
- Language: Python
- Size: 716 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Authors: AUTHORS.txt
Awesome Lists containing this project
README
# nau openedx extensions
NAU Open edX extensions is a [django app plugin](https://github.com/edx/edx-platform/tree/master/openedx/core/djangoapps/plugins) to make easier change or extend [edx-platform](https://github.com/edx/edx-platform)
## Installation
[Documentation](docs/installation.rst) about the installation.
## Usage
[Usage details](docs/usage.rst).
## Python
This package requires the same Python version of the edx-platform.
For redwood Python 3.11.
## Virtual environment
Create a python virtual environment.
```bash
python -m venv venv
```
And activate it.
Further steps should be run inside this virtual environment.
## Install requirements
```bash
make requirements
```
## Tests
To run the python tests execute, inside the previous create virtual environment.
```bash
make test
```
## Lint
To run the linters to check code quality, inside the previous create virtual environment.
```bash
make lint
```
## Translations
To extract, update translations files and to compile, simply run.
`make translations`
To translate, change the conf/locale//LC_MESSAGES/django.po files.
Then to compile, just execute the same Makefile target.
`make translations`
## VSCode
To make VSCode detect the edx-platform code, add this to your project settings.
```json
{
"python.autoComplete.extraPaths": ["${workspaceFolder}/../edx-platform"],
"python.analysis.extraPaths": ["${workspaceFolder}/../edx-platform"],
}
```