.. Parsons documentation master file, created by sphinx-quickstart on Sat Sep 8 14:41:56 2018. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. About ===== Parsons, named after `Lucy Parsons `_, is a Python package that contains a growing list of connectors and integrations to move data between various tools. Parsons is focused on integrations and connectors for tools utilized by the progressive community. Parsons was built out of a belief that progressive organizations spend far too much time building the same integrations, over and over and over again, while they should be engaged in more important and impactful work. It was built and is maintained by The Movement Cooperative. The Movement Cooperative ======================== The Movement Cooperative is a member led organization focused on providing data, tools and strategic support for the progressive community. Our mission is to break down technological barriers for organizations that fight for social justice. License and Usage ================= Usage of Parsons is governed by a `modified Apache License with author attribution statement `_. Design Goals ============ The goal of Parsons is to make the movement of data between systems as easy and straightforward as possible. Simply put, we seek to reduce the lines of code that are written by the progressive community. Not only is this a waste of time, but we rarely have the capacity and resources to fully unittest our scripts. .. image:: /_static/parsons_diagram.png Parsons seeks to be flexible from a data ingestion and output perspective, while providing ETL tools that recognize that our data is **always** messy. Central to this concept is the :ref:`parsons-table` the table-like object that most methods return. QuickStart ========== .. code-block:: python # VAN - Download activist codes to a CSV from parsons import VAN van = VAN(db='MyVoters') ac = van.get_activist_codes() ac.to_csv('my_activist_codes.csv') # Redshift - Create a table from a CSV from parsons import Table tbl = Table.from_csv('my_table.csv') tbl.to_redshift('my_schema.my_table') # Redshift - Export from a query to CSV from parsons import Redshift sql = 'select * from my_schema.my_table' rs = Redshift() tbl = rs.query(sql) tbl.to_csv('my_table.csv') # Upload a file to S3 from parsons import S3 s3 = S3() s3.put_file('my_bucket','my_table.csv') # TargetSmart - Append data to a record from parsons import TargetSmart ts = TargetSmart(api_key='MY_KEY') record = ts.data_enhance(231231231, state='DC') Sources ======= * Documentation: ``_ * Source Code: ``_ Virtual Environments ==================== Normally, tools like `pip` install Python libraries directly to your system. Python scripts or libraries look for their dependencies in your system. This can cause problems when you have two scripts/libraries installed that require different versions of the same library. To solve this problem, we recommend you use *virtual environments* to install Parsons. Virtual environments allow you to keep different sets of installed libraries so that you can use different versions of the same libraries for different purposes. Windows ------------------------------ `Source `_ 1. Install virtualenvwrappers from source:: git clone git://github.com/davidmarble/virtualenvwrapper-win.git cd virtualenvwrapper-win python setup.py install 2. Find the ``Scripts\`` directory for your Python installation, such as ``C:\Users\\AppData\Local\Programs\Python\Python37\Scripts\``. 3. Add the ``Scripts\`` directory to your Path. 4. To create a virtual environment for Parsons, execute: ``mkvirtualenv parsons`` 5. To use this virtual environment, execute: ``workon parsons`` Linux / Mac OS ------------------------------ Installation ============ There are two ways to install Parsons: Using pip and from source. Use pip if you just want to install Parsons and start using it. Install from source if you might want to patch Parsons to customize its behavior. Installing Parsons (pip) ----------------------------- 1. Make sure you're in your parsons virtual environment: ``workon parsons``. 2. Execute: ``pip install parsons`` Installing Parsons from Source ---------------------------------- 1. Make sure you're in your parsons virtual environment: ``workon parsons``. 2. Execute these commands:: git clone https://github.com/move-coop/parsons.git pip install -r requirements.txt python setup.py install 3. To update your installation, pull the most recent branch from the Parsons GitHub repo (``git pull origin master``) and rerun ``python setup.py install``. Logging ======= Parsons uses the `native python logging system `_. By default, log output will go to the console and look like: .. code-block:: none parsons.modulename LOGLEVEL the specific log message In your scripts that use Parsons, if you want to override the default Parsons logging behavior, just grab the "parsons" logger and tweak it: .. code-block:: python import logging parsons_logger = logging.getLogger('parsons') # parsons_logger.setLevel('DEBUG') # parsons_logger.addHandler(...) # parsons_logger.setFormatter(...) Integrating Parsons =================== A primary goal of Parsons is to make installing and use as easy as possible. Many of the patterns and examples that we document are meant to show how easy it can be to use Parsons, but sometimes these patterns trade immediate accessibility against ease of integration. In environments where Parsons is not the primary application, or in scenarios where Parsons must run with limited resources, we recommend users install only the dependencies they need at loose version constraints. To do this, simply set the `PARSONS_LIMITED_DEPENDENCIES` environment variable to "true" before installing Parsons and keep it while running: ``` export PARSONS_LIMITED_DEPENDENCIES=true pip install parsons ``` ``` export PARSONS_LIMITED_DEPENDENCIES=true python myparsons_script.py ``` When the `PARSONS_LIMITED_DEPENDENCIES` environment variable is set, pip will install the bare minimum dependencies needed to run Parsons. Users may also install extra dependencies appropriate to their environment, e.g. ``` export PARSONS_LIMITED_DEPENDENCIES=true pip install parsons[google] ``` or ``` export PARSONS_LIMITED_DEPENDENCIES=true pip install parsons[google,ngpvan] ``` *** Don't import from the root Parsons package *** Throughout the Parsons documentation, users are encouraged to load Parsons classes like so: .. code-block:: python from parsons import Table In order to support this pattern, Parsons imports all of its classes into the root `parsons` package. Due to how Python loads modules and packages, importing even one Parsons class results in ALL of them being loaded. The `PARSONS_LIMITED_DEPENDENCIES` variable tells Parsons to skip this; it will not import all of its classes into the root `parsons` package. Setting this environment variable means you will **NOT** be able to import using the `from parsons import X` pattern. Instead, you will need to import directly from the package where a class is defined (e.g. `from parsons.etl import Table`). Using this method, you may see as much as an 8x decrease in memory usage for Parsons! Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. toctree:: :maxdepth: 1 :caption: Integrations :name: integrations actblue action_kit action_network airtable alchemer aws azure bill_com bloomerang bluelink box braintree civis controlshift copper crowdtangle databases facebook_ads freshdesk github google hustle mailchimp mobilize_america newmode ngpvan pdi p2a quickbase redash rockthevote salesforce sftp shopify sisense targetsmart turbovote twilio zoom .. toctree:: :maxdepth: 1 :caption: Enhancements :name: enhancements census_geocoder .. toctree:: :maxdepth: 1 :caption: Framework :name: framework dbsync table notifications utilities .. toctree:: :maxdepth: 1 :caption: Contributor Documentation :name: contrib_docs contributing build_a_connector write_tests .. toctree:: :maxdepth: 1 :caption: Use Cases and Sample Scripts :name: use_cases_and_sample_scripts use_cases/contribute_use_cases use_cases/civis_job_status_slack_alert use_cases/mysql_to_googlesheets .. toctree:: :maxdepth: 1 :caption: Training Guides :name: training_guides training_guides/getting_set_up