# ckey
### OpenFEC API client for researching the political ideology of executives
Copyright (c) 2024 Justin G. Davis.
## Overview
Ckey is a data collection and analysis tool that uses executive information from ExecuComp to capture political contribution data from openFEC, the Federal Election Commission (FEC) API. It allows researchers to construct measures of executive political ideology based on the executives' political contributions.
> **Disclaimer** - Ckey is not affiliated with, endorsed by, or vetted by ExecuComp.
## Features
- **User-Friendly** - Designed for researchers with minimal Python experience
- **Data Processing** - Automated cleaning and formatting of ExecuComp data
- **API Integration** - Efficient data collection from openFEC API with built-in rate limiting
- **Compliance** - Integrated adherence to openFEC API usage policies
- **Political Analysis** - Construction of all commonly used political ideology measures
- **Accurate Matching** - Robust executive-to-contribution matching using name, employer, and occupation verification
## Installation
```bash
pip install ckey
```
## Prerequisites & Dependencies
### Prerequisites
- Python 3.6 or higher
- Access to ExecuComp data
- FEC API key (obtain from [FEC.gov](https://api.open.fec.gov/developers))
### Python Dependencies
- pandas >= 2.0.0
- requests >= 2.31.0
- ThreadPoolExecutorPlus >= 0.2.2
Note: Python dependencies are automatically installed during the pip installation
## Usage Guide
### Basic Usage
```python
import ckey
ckey.run(
data_path='your ExecuComp data.csv',
id_column='exec id column in the data',
name_column='name column in the data',
company_column='company column in the data',
year_column='year column in the data',
key='YOUR_API_KEY'
)
```
For detailed usage instructions and methodology, please see:
[Citation information to be added]
## Citation
If you use this tool in your research, please cite:
[Citation information to be added]
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
Thank you to:
- The FEC for providing and maintaining the openFEC API.
- The openFEC support staff for their assistance throughout the development process.
## Author
Justin G. Davis
Raw data
{
"_id": null,
"home_page": "https://github.com/justin-g-davis/ckey",
"name": "ckey",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Justin G. Davis",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5b/3f/701a1efcc02fe8f4c39a17d6c5c254bc2d65f0184f22f51c6485ca971fd4/ckey-1.0.0a1.tar.gz",
"platform": null,
"description": "# ckey\r\n### OpenFEC API client for researching the political ideology of executives\r\n\r\nCopyright (c) 2024 Justin G. Davis.\r\n\r\n## Overview\r\nCkey is a data collection and analysis tool that uses executive information from ExecuComp to capture political contribution data from openFEC, the Federal Election Commission (FEC) API. It allows researchers to construct measures of executive political ideology based on the executives' political contributions.\r\n\r\n> **Disclaimer** - Ckey is not affiliated with, endorsed by, or vetted by ExecuComp.\r\n\r\n## Features\r\n- **User-Friendly** - Designed for researchers with minimal Python experience\r\n- **Data Processing** - Automated cleaning and formatting of ExecuComp data\r\n- **API Integration** - Efficient data collection from openFEC API with built-in rate limiting\r\n- **Compliance** - Integrated adherence to openFEC API usage policies\r\n- **Political Analysis** - Construction of all commonly used political ideology measures\r\n- **Accurate Matching** - Robust executive-to-contribution matching using name, employer, and occupation verification\r\n\r\n## Installation\r\n```bash\r\npip install ckey\r\n```\r\n\r\n## Prerequisites & Dependencies\r\n\r\n### Prerequisites\r\n- Python 3.6 or higher\r\n- Access to ExecuComp data\r\n- FEC API key (obtain from [FEC.gov](https://api.open.fec.gov/developers))\r\n\r\n### Python Dependencies\r\n- pandas >= 2.0.0\r\n- requests >= 2.31.0\r\n- ThreadPoolExecutorPlus >= 0.2.2\r\n\r\nNote: Python dependencies are automatically installed during the pip installation\r\n\r\n## Usage Guide\r\n\r\n### Basic Usage\r\n```python\r\nimport ckey\r\n\r\nckey.run(\r\n data_path='your ExecuComp data.csv',\r\n id_column='exec id column in the data',\r\n name_column='name column in the data',\r\n company_column='company column in the data',\r\n year_column='year column in the data',\r\n key='YOUR_API_KEY'\r\n)\r\n```\r\nFor detailed usage instructions and methodology, please see:\r\n\r\n[Citation information to be added]\r\n\r\n## Citation\r\nIf you use this tool in your research, please cite:\r\n\r\n[Citation information to be added]\r\n\r\n## License\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n## Acknowledgments\r\nThank you to:\r\n- The FEC for providing and maintaining the openFEC API.\r\n- The openFEC support staff for their assistance throughout the development process.\r\n\r\n## Author\r\nJustin G. Davis\r\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenFEC API client for researching the political spending of executives",
"version": "1.0.0a1",
"project_urls": {
"Homepage": "https://github.com/justin-g-davis/ckey"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c800afdbba5347edc7da19a416a4c414b7e36a83881c68d33f4982bb1394cfa2",
"md5": "09491e684873d07e36530c739f97d560",
"sha256": "aa28c5d87a95424a5d2efd541bcbaa8df05054081e390ab62cca680bdad8628d"
},
"downloads": -1,
"filename": "ckey-1.0.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09491e684873d07e36530c739f97d560",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5802,
"upload_time": "2024-12-09T15:01:40",
"upload_time_iso_8601": "2024-12-09T15:01:40.754826Z",
"url": "https://files.pythonhosted.org/packages/c8/00/afdbba5347edc7da19a416a4c414b7e36a83881c68d33f4982bb1394cfa2/ckey-1.0.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b3f701a1efcc02fe8f4c39a17d6c5c254bc2d65f0184f22f51c6485ca971fd4",
"md5": "829085616b6c4bccb307fa337c7c0ae1",
"sha256": "304329d65f3fbbceac60f4618e54ac6becff17ce7d5365966a0f5195aa5f3750"
},
"downloads": -1,
"filename": "ckey-1.0.0a1.tar.gz",
"has_sig": false,
"md5_digest": "829085616b6c4bccb307fa337c7c0ae1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4506,
"upload_time": "2024-12-09T15:01:42",
"upload_time_iso_8601": "2024-12-09T15:01:42.654558Z",
"url": "https://files.pythonhosted.org/packages/5b/3f/701a1efcc02fe8f4c39a17d6c5c254bc2d65f0184f22f51c6485ca971fd4/ckey-1.0.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 15:01:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "justin-g-davis",
"github_project": "ckey",
"github_not_found": true,
"lcname": "ckey"
}
JSON
