Skip to main content

pynssp

pynssp Pipeline pynssp documentation Project Status: Active Lifecycle: experimental PyPI - Downloads PyPI

Overview

A Python package for the National Syndromic Surveillance Program (NSSP) and its Community of Practice. A collection of classes and methods to advance the practice of Syndromic Surveillance. This python package serves as a Python alternative to the Rnssp R package.

Installation

Stable release

To install pynssp, run this command in your terminal:

pip install pynssp

This is the preferred method to install pynssp, as it will always install the most recent stable release.

Development version

You can install the development version of pynssp from Github:

pip install git+https://github.com/CDCgov/pynssp.git

Usage

from pynssp import *
from datetime import date, timedelta
import pandas as pd


## Creating a user profile (token)
myProfile = create_token_profile()

## Creating a user profile (username and password)
myProfile = create_profile()

## JSON URL from NSSP-ESSENCE API
url = "https://essence.syndromicsurveillance.org/nssp_essence/api/alerts/regionSyndromeAlerts?end_date=31Jan2021&start_date=29Jan2021"

## Update Start and End dates in NSSP-ESSENCE API URL
startDate = date.today() - timedelta(days=30)
endDate = date.today()

url = change_dates(url, start_date = startDate, end_date = endDate)

## Pull Time Series Data from NSSP-ESSENCE
api_data = get_api_data(url, profile=myProfile)

## Inspect data object structure
api_data.columns

## Extract table of interest
api_data = pd.json_normalize(api_data["regionSyndromeAlerts"][0])

## Get a glimpse of the pulled dataset
api_data.head()

Contributing to this project

Should you want to contribute to this project, submit a push request to this Github repository and consider submitting a request to be added as a developer to gazondekon@cdc.gov.

Getting Help

If you encounter a clear bug, please consider emailing the author at gazondekon@cdc.gov and/or file an issue with a minimal reproducible example.

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC ? 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Release Notes

0.2.0 (2026-11-03)

Bug fixes

  • The install issue related to package data has been fixed.
  • The package info to document Python support up to 3.14 has been updated
  • The change_dates() function has been upgraded to fix flip-flopping start and end date values.
  • The EWMA detector has been updated to closely match the Rnssp's implementation. In addition, the alert_ewma() function has been updated with a patch to prevent errors when detector is applied to a zero series.
  • The Regression detector has been updated to closely match the Rnssp's implementation.
  • The Switch detector has been updated to closely match the Rnssp's implementation.

New Features

Anomaly Detection

  • The Farrington Temporal Detector algorithm alert_farrington() has been added for weekly time series of counts spanning multiple years.

Credentials Management

  • A new abstract class Auth has been added.
  • Both the Credentials and Token classes inherit the Auth class.
  • A new Apikey class has been added for API services token use.

Classes

  • The Auth class delineates methods Shared by the Token, Credentials, and Apikey Classes. The new Apikey class inherits the Auth class, and has the same methods as the Credentials and Token classes.

Utility Functions

  • A new create_apikey_profile() function has been added as a wrapper to the Apikey class.

Other

  • A section on the Farrington Temporal detector has been added to the Anomaly Detection vignette.
  • A trend classification section has been added to the Anomaly Detection vignette.
  • A new vignette entitled "Text Mining Example" has been added to the package documentation.
  • The online documentation has a new theme.

0.1.0 (2023-06-22)

  • First release on PyPI.

Features

Credentials Management

  • create_profile() initializes a Credentials object from a username and password.
  • create_token_profile() initializes a Token object from a REST API token.

REST API data pulls

  • get_api_response() retrieves a response from an API service using a provided profile of type Credentials or Token. Used as a wrapper to the .get_api_response() method of a provided profile of type Credentials or Token.
  • get_api_data() retrieves data (in JSON or CSV) from an API service using a provided profile of type Credentials or Token. Used as a wrapper to the .get_api_data() method of a provided profile of type Credentials or Token.
  • get_api_graph() retrieves a graph from an API service using a provided profile of type Credentials or Token. Used as a wrapper to the .get_api_graph() method of a provided profile of type Credentials or Token.
  • get_essence_data() retrieves data from the NSSP-ESSENCE API service using a provided profile of type Credentials or Token.

Anomaly Detection and Trend Classification

  • alert_ewma() implements the EWMA time series anomaly detection algorithm.
  • alert_regression() implements the Multiple Adaptive Regression time series anomaly detection algorithm.
  • alert_switch() implements the Regression/EWMA Switch time series anomaly detection algorithm
  • alert_nbinom() implements the Negative Binomial Regression time series anomaly detection algorithm.
  • alert_serfling() implements the original and modified Serfling method for time series anomaly detection.
  • classify_trend() fits rolling binomial models to a daily time series of percentages or proportions to classify the overall trend.

Added Data

  • load_simulated_ts() loads a dataframe of simulated time series.
  • load_nssp_stopwords() loads a dataframe of NSSP-curated stopwords.
  • get_scenario1() loads a a subset of the simulated time series data ("scenario #1").
  • get_scenario2() loads a a subset of the simulated time series data ("scenario #2").

Utility Functions

  • change_dates() modifies the start and end dates in a given URL to new dates, if provided.
  • webscrape_icd() scrapes ICD Codes from the Web.

Classes

  • Credentials is an abstract representation of a profile object given a username and password strings.
  • Token is an abstract representation of a profile object given a token string.
  • APIGraph is an abstract representation of a graph object returns from an API service.
  • NSSPContainer encapsulates a value or an object to store.

Metadata

Release files for pynssp 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pynssp 0.2.0
File Size Uploaded Provenance Actions
pynssp-0.2.0.tar.gz 1.7 MB Without provenance Details for pynssp-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pynssp 0.2.0
File Interpreter ABI Platform Actions
pynssp-0.2.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for pynssp-0.2.0-py2.py3-none-any.whl

Total release size: 1.8 MB

Release files / pynssp-0.2.0.tar.gz

Download URL pynssp-0.2.0.tar.gz
Size 1.7 MB
Tags Source
SHA-256 checksum
How to use checksums
c8d7de17b899259f21c36ec3bafab87b9e627911317189f7dc0a0f3c8e2d79aa
BLAKE2b-256 checksum
How to use checksums
b0efb5a6f50ab3b6f8f7f99b8a1afc1359c45cf6920f3fcb299640ce65d6c4cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / pynssp-0.2.0-py2.py3-none-any.whl

Download URL pynssp-0.2.0-py2.py3-none-any.whl
Size 52.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
faa341a86611e12a080873d342ced63543a8640738a4ccf099d68270d340ca9d
BLAKE2b-256 checksum
How to use checksums
02b3ba1f5d008ee85d1d07ad77bcdefa35af328a348adfb824bc60d47bab906d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for pynssp 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page