Skip to content

Commit

Permalink
Write initial tutorials (install and get started)
Browse files Browse the repository at this point in the history
  • Loading branch information
daffidwilde committed Nov 30, 2023
1 parent e14115c commit 8beda57
Show file tree
Hide file tree
Showing 3 changed files with 365 additions and 0 deletions.
309 changes: 309 additions & 0 deletions docs/tutorials/getting-started.ipynb

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions docs/tutorials/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Tutorials
listing:
type: table
contents:
- installation.qmd
- getting-started.ipynb
- "*.ipynb"
fields: [title, description]
sort: false
---

In these tutorials, we walk through how to install the package and perform some
basic workflows to interact with Census data.

<br>
40 changes: 40 additions & 0 deletions docs/tutorials/installation.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Installing the package
description: >
Instructions for the various ways you can install the `census21api` package
---

Currently, the `census21api` package is only installable through GitHub. We
also require Python 3.8 or higher.

## Installing from GitHub via `pip`

To install from GitHub via `pip`, use the following command:

```bash
$ python -m pip install census21api@git+https://github.com/datasciencecampus/census21api
```

## Installing from source

If you would prefer to install directly from source, use the following
commands:

```bash
$ git clone https://github.com/datasciencecampus/census21api.git
$ cd census21api
$ python -m pip install .
```

## Installing to contribute

If you intend on doing any sort of development on `census21api` - like writing documentation or implementing a new feature - it is highly recommended to
install from source _as editable_ and _with the development dependencies_.

To do so, make a fork of the repository and then run the following:

```bash
$ git clone https://github.com/<your-username>/census21api.git
$ cd census21api
$ python -m pip install -e ".[dev]"
```

0 comments on commit 8beda57

Please sign in to comment.