<commit_before>![Python 3.6](https://img.shields.io/badge/python-3.6-brightgreen.svg)

# qualtrics-mailer
A package for importing contact lists and distributing pre-built surveys in Qualtrics

## Getting Started

1. Download this repo.
2. Prepare a CSV file with your contact list using the  file [example_mailing_list.csv](example_mailing_list.csv) as a template; note that column headers must be formatted exactly as specified at [https://api.qualtrics.com/docs/update-contact](https://api.qualtrics.com/docs/update-contact).
3. Update [example_usage.py](example_usage.py) with a Qualtrics API token and object IDs.

Instructions for generating an API token can be found at
[https://www.qualtrics.com/support/integrations/api-integration/overview/](https://www.qualtrics.com/support/integrations/api-integration/overview/)

Instructions for finding Qualtrics objects ids can be found at
[https://api.qualtrics.com/docs/finding-qualtrics-ids](https://api.qualtrics.com/docs/finding-qualtrics-ids)

Additional documentation for the Qualtrics API can be found at [https://api.qualtrics.com/docs/overview](https://api.qualtrics.com/docs/overview)

### Prerequisites

This package requires Python 3.6 or greater, along with the Python modules specified in [requirements.txt](requirements.txt).

This package requires a paid Qualtrics account with API add-on. Details about purchasing a Qualtrics account and/or API add-on can obtained by contacting Qualtrics at [https://www.qualtrics.com/contact/](https://www.qualtrics.com/contact/)

## Running the tests

To use the provided functional and unit tests, follow the instructions in [tests/example_test_config.py](tests/example_test_config.py), and then run the tests as follows:
```
python -m unittest tests/functional_tests.py
```
and
```
python -m unittest tests/unit_tests.py
```

## License(s)
MIT License, See [LICENSE](LICENSE)

## Authors
* [ilankham](https://github.com/ilankham)
* [kaiichang](https://github.com/kaiichang)

## Disclaimer

This project is in no way affiliated with Qualtrics.
<commit_msg>Update README.md license section<commit_after>![Python 3.6](https://img.shields.io/badge/python-3.6-brightgreen.svg)

# qualtrics-mailer
A package for importing contact lists and distributing pre-built surveys in Qualtrics

## Getting Started

1. Download this repo.
2. Prepare a CSV file with your contact list using the  file [example_mailing_list.csv](example_mailing_list.csv) as a template; note that column headers must be formatted exactly as specified at [https://api.qualtrics.com/docs/update-contact](https://api.qualtrics.com/docs/update-contact).
3. Update [example_usage.py](example_usage.py) with a Qualtrics API token and object IDs.

Instructions for generating an API token can be found at
[https://www.qualtrics.com/support/integrations/api-integration/overview/](https://www.qualtrics.com/support/integrations/api-integration/overview/)

Instructions for finding Qualtrics objects ids can be found at
[https://api.qualtrics.com/docs/finding-qualtrics-ids](https://api.qualtrics.com/docs/finding-qualtrics-ids)

Additional documentation for the Qualtrics API can be found at [https://api.qualtrics.com/docs/overview](https://api.qualtrics.com/docs/overview)

### Prerequisites

This package requires Python 3.6 or greater, along with the Python modules specified in [requirements.txt](requirements.txt).

This package requires a paid Qualtrics account with API add-on. Details about purchasing a Qualtrics account and/or API add-on can obtained by contacting Qualtrics at [https://www.qualtrics.com/contact/](https://www.qualtrics.com/contact/)

## Running the tests

To use the provided functional and unit tests, follow the instructions in [tests/example_test_config.py](tests/example_test_config.py), and then run the tests as follows:
```
python -m unittest tests/functional_tests.py
```
and
```
python -m unittest tests/unit_tests.py
```

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details MIT License

## Authors
* [ilankham](https://github.com/ilankham)
* [kaiichang](https://github.com/kaiichang)

## Disclaimer

This project is in no way affiliated with Qualtrics.

{'fraction_non_alphanumeric': 0.10868014268727705, 'fraction_numerical': 0.004280618311533888, 'mean_word_length': 5.051798561151079, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 26, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1230720', 'n_tokens_mistral': 1292, 'n_tokens_neox': 1233, 'n_words': 385}