Metadata-Version: 2.1
Name: jupyter-mindmaps
Version: 1.0.0
Summary: Mindamps of Space
Author: John Capobianco
Author-email: ptcapo@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Jinja2 (>=3.1.2,<4.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: rich-click (>=1.5.2,<2.0.0)
Description-Content-Type: text/markdown

![Logo](/images/Jupyter.png)
# Jupyter

Mind Maps of Space

![Planets](images/planets.png)

![People In Space](images/people.png)

## Introduction 

Using various APIs Jupyter collects JSON data and then uses Jinja2 templates to create markdown files. Using the markmap VS Code extension these markdown files render as mind maps! 

## NASA API Key 

Please visit [NASA](api.nasa.gov)

And register for an API key. Once you have your key please add it to the .env file

## Setup

I recommend running Jupyter in a Python virtual environment. This will help keep your host system clean and allow you to have multiple environments to try new things. If you are not using a virtual environment, start at the download/clone step below.

You will also need Python 3 and venv installed on your host system.

In your project directory, create your virtual environment
``` console
python3 -m venv env
```
Activate (use) your new virtual environment (Linux):
``` console
source env/bin/activate
```
Pip Install the package using pip install jupyter_mindmaps:

``` console
(env)pip install jupyter_mindmaps
```

## Run the code help

```console
(env)jupyter_mindmaps --help
```
![Help](images/help.png)

## Run the code passing the key

```console
(env)jupyter_mindmaps --token { your NASA token }
```
## Run the code interactively

```console
(env)jupyter_mindmaps
NASA Token: { your NASA token }
```
## View the Mindmaps 

Type code . to launch VS Code in the folder 

Install the markmap VS Code Extension

![Mark Map](images/markmap.png)

Open the markdown file and click the "Open as markmap" 

## API List
The following files are created from the various APIs. The Space.md file contains <b>all</b> APIs. 

![List](/images/API_List.png)

Original background photo credit 
[Photo](https://www.nasa.gov/audience/forstudents/k-4/dictionary/Solar_System.html)

