Skip to content

ianepreston/stats_can

Repository files navigation

Python api for Statistics Canada New Data Model (NDM)

Tests Documentation Status PyPI version Anaconda-Server Badge

API documentation for StatsCan can be found on the web data service docs

If you're looking for Table/Vector IDs to use in the app you can find them through the StatCan data page

Anaconda package

Read the docs

Introduction

This library implements most of the functions defined by the Statistics Canada Web Data Service. It also has a number of helper functions that make it easy to read Statistics Canada tables or vectors into pandas dataframes.

Installation

The package can either be installed with pip or conda:

conda install -c conda-forge stats_can

Or:

pip install stats-can

The code is also available on

github.

Contributing

Contributions to this project are welcome. Fork the repository from github.

You'll need a python environment with poetry installed. A good guide for setting up an environment and project (that I used for this library) is hypermodern python.

I've configured the project to use nix for environment creation. If you use nix then the makefile in the root of the project will let you create development environments and run tests. However you like to configure a uv project should work though.

I'd also welcome contributions to the docs, or anything else that would make this tool better for you or others.

About

Get Statistics Canada data into python (mostly pandas)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11