Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write some content for the documentation #42

Merged
merged 4 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,4 @@ cython_debug/
#.idea/

/.quarto/
/_site/
16 changes: 9 additions & 7 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@ project:
type: website

website:
title: "Census 2021 API"
title: "`census21api`"
navbar:
left:
- href: docs/tutorials/index.qmd
text: Tutorials
- href: docs/reference/index.qmd
text: Reference
right:
- icon: github
href: https://github.com/datasciencecampus/census21api

page-footer:
left: >
All content is available under the
[Open Government Licence V3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/),
except where otherwise stated.
Built using [Quarto](https://quarto.org/).
page-footer:
left: >
All content is available under the
[Open Government Licence V3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/),
except where otherwise stated.<br>
Built using [Quarto](https://quarto.org/).

format:
html:
Expand Down
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]"
```
29 changes: 27 additions & 2 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,35 @@ title: Welcome to the `census21api` documentation!
toc: false
about:
id: welcome
template: marquee
links:
- icon: github
href: https://github.com/datasciencecampus/census21api
text: GitHub
---

:::{#welcome}
:::
## What is this and why does it exist?

This package, `census21api`, is the (unofficial) Python interface to the
["Create a Custom Dataset"](https://www.ons.gov.uk/datasets/create) web tool
for the 2021 England and Wales Census.

The primary goal of this project is to streamline the process of accessing and
working with data from the 2021 England and Wales Census API. With
`census21api`, you can create pretty much any Census tables you like in a
programmatic way.

## Who made this?

The package and its documentation were developed by the 2023 cohort of Office
for National Statistics data engineering and architecture apprentices -- with
support from the [Data Science Campus](https://datasciencecampus.ons.gov.uk).

See our [citation file](https://github.com/datasciencecampus/census21api/blob/main/CITATION.cff)
for a list of our authors.

## Where do I go now?

Get stuck in with the package by checking out our
[tutorials](docs/tutorials/index.qmd). For closer details, consider our
[API reference](docs/reference/index.qmd).
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ lint = [
"ruff",
]
docs = [
"quartodoc>=0.5.0"
"quartodoc>=0.5.0",
"seaborn>=0.12.1"
]
dev = [
"census21api[test,lint,docs]",
Expand Down