Coverage for src/crimepy/__init__.py: 100%

1"""Accessible tools for crime data. 

2 

3crimepy downloads, combines, munges, analyzes, and plots crime data. 

4 

5Contents: 

6 Project: an `amos.Project`, for a study of crime data. 

7 analyze: counts crimes and computes rates, changes, and crosstabs. 

8 combine: stacks and merges tables of crime data. 

9 nibrs: tools for the FBI's National Incident-Based Reporting System. 

10 options: default settings of crimepy. 

11 plot: figures of crime data. 

12 techniques: techniques that analyze crime data, on `amos` datasets. 

13 utilities: small tools that the rest of crimepy shares. 

14 

15""" 

16 

17from __future__ import annotations 

18 

19__version__ = '0.2.1' 

20 

21__author__: str = 'Corey Rayburn Yung' 

22 

23__all__: list[str] = [ 

24 'Project', 

25 'analyze', 

26 'combine', 

27 'nibrs', 

28 'options', 

29 'plot', 

30 'techniques', 

31 'utilities'] 

32 

33# A study is an `amos.Project`, which crimepy offers under the same name. 

34from amos import Project 

35 

36# Importing `nibrs`, `plot`, and `techniques` adds their techniques to the 

37# `amos` library, so they can be named in settings as soon as crimepy is 

38# imported. 

39from . import analyze, combine, nibrs, options, plot, techniques, utilities