https://github.com/aagnone3/personal-capital-plus
Personal Capital library for accessing its API
https://github.com/aagnone3/personal-capital-plus
banking finance finance-api personal-capital personal-finance
Last synced: 5 months ago
JSON representation
Personal Capital library for accessing its API
- Host: GitHub
- URL: https://github.com/aagnone3/personal-capital-plus
- Owner: aagnone3
- License: mit
- Fork: true (haochi/personalcapital)
- Created: 2018-07-11T01:53:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-21T17:41:32.000Z (over 7 years ago)
- Last Synced: 2025-10-27T07:22:12.126Z (8 months ago)
- Topics: banking, finance, finance-api, personal-capital, personal-finance
- Language: Python
- Homepage:
- Size: 227 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. -*- mode: rst -*-
.. role:: bash(code)
:language: bash
|Travis|_ |PyPi|_ |TestStatus|_ |PythonVersion|_
.. |Travis| image:: https://travis-ci.org/aagnone3/personal-capital-plus.svg?branch=master
.. |PyPi| image:: https://badge.fury.io/py/personal-capital-plus.svg
.. _PyPi: https://badge.fury.io/py/personal-capital-plus
.. |TestStatus| image:: https://travis-ci.org/aagnone3/personal-capital-plus.svg
.. _TestStatus: https://travis-ci.org/aagnone3/personal-capital-plus.svg
.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/personal-capital-plus.svg
.. _PythonVersion: https://img.shields.io/pypi/pyversions/personal-capital-plus.svg
personal-capital-plus
================
Personal Capital + Python = Pipelined personal finance
Use your existing Personal Capital login credentials to pull the JSON data directly, allowing
you to perform any custom analyses you wish to. The API calls can be found by viewing the HTTP
calls the browser makes after login.
.. _entry.py: personalcapital/tools/entry.py
This library pulls the data into a Mongo database to enable local analysis. See entry.py_.
Documentation
-------------
Documentation can be found at the github pages here_
.. _here: https://aagnone3.github.io/personal-capital-plus/
Dependencies
~~~~~~~~~~~~
personal-capital-plus is tested to work under Python 3.x.
See the requirements via the following command:
.. code-block:: bash
cat requirements.txt
Installation
~~~~~~~~~~~~
personal-capital-plus is currently available on the PyPi's repository and you can
install it via `pip`:
.. code-block:: bash
pip install -U personal-capital-plus
If you prefer, you can clone it and run the setup.py file. Use the following
commands to get a copy from GitHub and install all dependencies:
.. code-block:: bash
git clone https://github.com/aagnone3/personal-capital-plus.git
cd personal-capital-plus
pip install .
Or install using pip and GitHub:
.. code-block:: bash
pip install -U git+https://github.com/aagnone3/personal-capital-plus.git
Now, to avoid a 2FA prompt each run, set the following environment variables:
.. code-block:: bash
export PEW_EMAIL=
export PEW_PASSWORD=
If you plan to use the `update` option of `pc_api`, set the following variable, indicating
the URL the POST to with a derived JSON payload. The payload is currently customized for my
own needs, but trace entry.py_ to go about changing it for yourself.
.. code-block:: bash
export PEW_PAYLOAD_URL=
With the environment defined, give it a whirl:
.. code-block:: bash
# only available if you've installed it
pc_api update
# otherwise, use this
PYTHONPATH=${PYTHONPATH:-}:${PWD} python personalcapital/tools/entry.py update
Local Testing
~~~~~~~~~~~~~
.. code-block:: bash
make test
Travis Testing
~~~~~~~~~~~~~~
The :bash:`Makefile`, :bash:`.travis.yml` file and :bash:`.ci` directory contain the structure necessary to have Travis_ test the repository upon all branch updates. Some additional steps, however, are needed:
- Enable the repository to be monitored by Travis via your Travis profile.
- Generate a Github app token, and assign it to the (private) environment variable :bash:`${GITHUB_TOKEN}` in the Travis environment.
.. _Travis: https://travis-ci.org/aagnone3/personal-capital-plus