Skip to main content

A comprehensive, feature-rich, and user-oriented Python package that wraps the U.S. Census Bureau's Data and Geographic APIs

Project description

Censaurus
=========

|version_badge|
|docs|

|logo|

Not just another Census data tool. *Seriously.*

``censaurus`` is a comprehensive, feature-rich, and user-oriented Python package that wraps the U.S. Census Bureau's Data and Geographic APIs.

Documentation
-------------

Check out the ``censaurus`` `documentation <https://censaurus.readthedocs.io/en/latest/index.html>`_. There you'll find an `introduction <https://censaurus.readthedocs.io/en/latest/introduction.html>`_ to the package, a `walkthrough <https://censaurus.readthedocs.io/en/latest/tutorial.html>`_ of a ``censaurus`` workflow, and full `API reference <https://censaurus.readthedocs.io/en/latest/api.html>`_.

Installation
------------

``censaurus`` is available on the `Python Package Index <https://pypi.org/project/censaurus/>`_, so it can be installed by running the following in the command line:

.. code-block::

pip install censaurus

Get Involved
------------

All contributions are welcomed! Please feel free to submit a `pull request <https://github.com/singerep/censaurus/pulls>`_ or point out an `issue <https://github.com/singerep/censaurus/issues>`_.


.. |docs| image:: https://readthedocs.org/projects/censaurus/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://docs.readthedocs.io/en/latest/?badge=latest

.. |logo| image:: https://raw.githubusercontent.com/singerep/censaurus/main/docs/source/censaurus_logo.png
:alt: censaurus logo

.. |version_badge| image:: https://badge.fury.io/py/censaurus.svg
:target: https://badge.fury.io/py/censaurus

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page