Sushi Chef script for importing Arvind Gupta toys content from http://www.arvindguptatoys.com/films.html
- Install the system prerequisites
ffmpeg
andimagemagick
by following the prerequisite install instructions. - Install Python 3 if you don't have it already.
- Make sure you also have
pip
installed by running the commandpip --help
in a terminal, and if missing install it. - Create a Python virtual environment for this project:
- Install the virtualenv package:
pip install virtualenv
- The next steps depends if you're using UNIX or Windows:
- For UNIX systems (Linux and Mac):
- Create a virtual env called
venv
in the current directory using the following command:virtualenv -p python3 venv
- Activate the virtualenv called
venv
by running:source venv/bin/activate
. Your command prompt should change and show the prefix(venv)
to indicate you're now working insidevenv
. - Checkpoint: Try running
which python
and confirm the Python in is use the one from the virtual env (e.g.venv/bin/python
) and not the system Python. Check alsowhich pip
is the one from the virtualenv. - You may encounter this error
SSL: CERTIFICATE_VERIFY_FAILED
. to fix it, at the terminal run the commandsudo /Applications/Python (your Python version)/Install Certificates.command
- Create a virtual env called
- For Windows systems:
- Create a virtual env called
venv
in the current directory using the following command:virtualenv venv
. - Activate the virtualenv called
venv
by running.\venv\Scripts\activate
- Checkpoint: Try running
python --version
and confirm the Python version that is running is the same as the one you downloaded in step 2.
- Create a virtual env called
- For UNIX systems (Linux and Mac):
- Install the virtualenv package:
source credentials/proxy_list.env
nohup ./sushichef.py -v --reset --compress --thumbnails --token=credentials/channeladmin.token &
A sushi chef script has been created for you in sushichef.py
to help you get
started on the import of the content.
- Start by looking at the channel spec that describes the target channel structure, licensing information, and tips about content transformations that might be necessary.
- Add the code necessary to create this channel by modifying the
construct_channel
method of the chef class defined insushichef.py
.
Use the following rubric as a checklist to know when your sushi chef script is done:
- Does the channel correspond to the spec provided?
- Does the content render as expected when viewed in Kolibri?
- Is the channel uploaded to Studio and PUBLISH-ed?
- Is the channel imported to a demo server where it can be previewed?
- Is the information about the channel token, the studio URL, and demo server URL
on notion card up to date? See the Studio Channels table.
If a card for your channel yet doesn't exist yet, you can create one using
the
[+ New]
button at the bottom of the table.
- Do all nodes have appropriate titles?
- Do all nodes have appropriate descriptions (when available in the source)?
- Is the correct language code set on all nodes and files?
- Is the
license
field set to the correct value for all nodes? - Is the
source_id
field set consistently for all content nodes? Use unique identifiers based on the source website or permanent url paths.
- Does the section
Usage
in this README contain all the required information for another developer to run the script? Document and extra credentials, env vars, and options needed to run the script. - Is the Python code readable and succinct?
- Are clarifying comments provided where needed?
See the ricecooker docs for more info.