Workspace projects are authored using a combination of DataCamp's Workspace and Teach Editor products.
This article focuses on how to create a sample Workspace for your project, which is what learners will see when they open your project for the first time. It should contain:
notebook.ipynbfile, within which there should be:
A markdown cell at the top, known as "Context", which provides information about the project such as a scenario learners are working in, an overview of the data, and any other relevant information. See this article for an overview of a Workspace project's anatomy.
A code cell with sample code, such as the import of required libraries and/or code comments.
The dataset saved as a relevant file type e.g., csv, xlsx, JSON, etc.
Any images or other files that are required for the project.
For an overview of the Teach Editor for Workspace projects please refer to this article.
Setting up an integration
If your project involves the use of a SQL database, please contact the Content team for support in setting this up.
Developing a Workspace
To develop a Workspace, you need to navigate to https://app.datacamp.com/workspace/overview.
Once here, you can create a new Workspace using the green "Create workspace" button on the left hand-side:
This will open a pop-up window, in which you can add a Workspace name, which should be the name of your project. You should set Workspace Visibility set to "Private" and Language set to "Python + SQL" if creating a Python or SQL project, or "R + SQL" if creating a R project. If you are using an existing integration such as a SQL database, you can select it from the Integration dropdown menu. Lastly, select the Create Workspace button.
This will create a new Workspace where you can author the project. You need to complete the following steps:
Select the "Browse and upload files" tab on the left-hand side.
Either select the browse files link or drag and drop your file(s) into the area below.
(Optional) If you plan to display an image in your notebook then please also upload the file during this step.
Select the Add Text button.
Select the Move Up button to the right of the text cell to move it above the code cell.
Author your Context to describe and motivate the project using Markdown.
Add Sample Code
Add code to the existing code cell. This will appear when learners start the project, so typically imports required libraries and possibly reads in data as a variable.
Exporting your Workspace
Once you have finished authoring your Workspace, click on File in the top-left, then "Download workspace".
This will download a zipped folder containing your notebook and all uploaded files.
Please note that your Workspace must contain code in a notebook rather than a script.
Rename the zipped folder to
Uploading your Workspace to GitHub
Your project lives in a GitHub repo that will be created by the Content team. During development, all edits you make to your project will be in the
To add your Workspace into the Teach Editor you need to navigate to your project's GitHub repo and ensure you are in the
Once there, select Add file then choose Upload files from the dropdown menu.
Either click on "choose your files" or drag and drop
template.zipinto the selected area.
Add a commit message.