nteract-on-ckan is a customized fork of nteract that queries ckan api throught an api server that exposes openapi 3 specifications. It enables to search and load directly from data.gov in your notebook, but can be connected easily with every ckan you want.
This repo contains the instructions for launching a working environment via docker compose and contains a set of notebooks and tutorials.
- Tutorial
- Analyses for example about mortality by cancer in Italian regions or European election
If you are a data scientist try to contribute by using the tools and share your work on this repository by making a PR.
- List of examples and analyses on
The stack is composed of:
- daf-nteract is a customisation of nteract.
- An api server
- Ckan, as metadata store for dataset.
With nteract-on-ckan you can:
- search datasets stored on ckan through the api
- automatically load data by running an autogerated snippet of code with many programming languages
- creating chart semi-automatically.
Can be used to have the first approach on notebooks, open data and visualizations.
Docker MUST be installed on your local machine
git clone git@github.com:teamdigitale/nteract-on-ckan.git
cd nteract-on-ckan
docker-compose up
It can take some time to download from dockerhub.
Save the token from the output of your console as: http://(b4fd9e3ef290 or 127.0.0.1):8888/?token=XXXXXXXXXXXXXX and open your browser at [http://localhost:8888]. If you are asked the token paste it.
You should see something like this:
CONGRATULATIONS NOW YOU ARE READY TO CONTRIBUTE.
Never made an open source contribution before?
-
Fork this repository to your local GitHub organization.
-
Clone the repository to your local machine using:
$ git clone https://github.com/github-username/repository-name.git
- Set the upstream repository by
$ git remote add upstream git@github.com:teamdigitale/nterat-on-ckan.git
-
Install the image and launch as in the steps described above
-
Create a new branch for your new analyses using:
$ git checkout -b branch-name-here
-
Create a new analysis on some public data provided by the platform
-
Add and commit the changed files using
git addandgit commit. -
Push the changes to the remote repository using:
$ git push origin branch-name-here
-
Submit a pull request to the upstream repository.
-
Title the pull request per the requirements outlined in the section below.
-
Set the description of the pull request with a brief description of what you did and any questions you might have about what you did.
-
Wait for the pull request to be reviewed by a maintainer.
-
Make changes to the pull request if the reviewing maintainer recommends them.
-
Celebrate your success after your pull request is merged! 🎉