Coverage for /home/runner/work/pycax/pycax/pycax/__init__.py: 88%

1""" 

2pycax library 

3~~~~~~~~~~~~~~~~~~~~~ 

4 

5pycax is a Python client for CAX. 

6 

7Example usage: 

8 

9# Import entire library 

10import pycax 

11# or import modules as needed 

12## hli 

13from pycax import hli 

14## tables 

15from pycax import tables 

16## datasets (a table of the available data sets) 

17from pycax import datasets 

18## utils 

19from pycax import utils 

20 

21## use advanced logging 

22### setup first 

23import requests 

24import logging 

25import httplib as http_client 

26http_client.HTTPConnection.debuglevel = 1 

27logging.basicConfig() 

28logging.getLogger().setLevel(logging.DEBUG) 

29requests_log = logging.getLogger("requests.packages.urllib3") 

30requests_log.setLevel(logging.DEBUG) 

31requests_log.propagate = True 

32### then make request 

33#from pycax import hli 

34#hli.get(fargs={'popid': 7}) 

35""" 

36 

37try: 

38 from ._version import __version__ 

39except ImportError: 

40 __version__ = "unknown" 

41 

42__title__ = "pycax" 

43__author__ = "Eli Holmes and Mari Williams" 

44__license__ = "MIT" 

45 

46from .hli import hli 

47from .datasets import datasets 

48from .tables import tables 

49 

50__all__ = [ 

51 "hli", 

52 "datasets", 

53 "tables", 

54] 

55 

56# Set the bibtex entry to the misc entry referenced in CITATION. 

57import sys 

58from pathlib import Path 

59def _get_bibtex(): 

60 refs = (Path(__file__).parent / "CITATION").read_text().split("@misc")[1:] 

61 return f"@misc{refs[0]}" if refs else "" 

62 

63__citation__ = __bibtex__ = _get_bibtex() 

64