Metadata-Version: 2.1
Name: parqet
Version: 1.0.2
Summary: A simple package to interact with the Parqet API.
Author: JoghurtConnaisseur
Project-URL: Homepage, https://github.com/JoghurtConnaisseur/parqet-python/
Keywords: parqet,api,fintech,portfolio,investing,stocks
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: loguru>=0.7.0
Requires-Dist: requests

# Parqet-Python

A simple package to interact with the Parqet API.

## Features
The parqet-python package will use the Parqet API to gather information about public Portfolios. Available infomration includes:
* Portfolio name
* Portfolio value
* Gain gross / net
* Total invested
* List of activities and holdings
* and many more..

## Getting Started

These instructions will tell you how to install the package and how to use it.

### Installing

Install the package via pip

    pip install parqet

### Usage
Create a `Portfolio` object and get the name of the portfolio:

    # This is an example of how to use the Portfolio class
    from parqet import Portfolio
   
    # Create a portfolio object
    portfolio = Portfolio("YOUR_PORTFOLIO_ID")
    
    # Print the name of the portfolio
    print(portfolio.get_name())
