<h1 align="center">
<br>
<img src="https://raw.githubusercontent.com/JoghurtConnaisseur/parqet-python/main/img/Parqet.png" alt="Parqet Logo" width="200">
<img src="https://raw.githubusercontent.com/JoghurtConnaisseur/parqet-python/main/img/python.png" alt="Python Logo" width="200">
<br>
parqet-python
<br>
</h1>
<h4 align="center">An inoffical package to communicate with the <a href="https://www.parqet.com/" target="_blank">Parqet</a> API.</h4>
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#download">Download</a> •
<a href="#credits">Credits</a> •
<a href="#related">Related</a> •
<a href="#license">License</a>
</p>
## Key Features
The parqet-python package will use the <a href="https://www.parqet.com/" target="_blank">Parqet</a> API to gather information about public Portfolios. Available information includes:
* Portfolio name
* Portfolio value
* Gain gross / net
* Total invested
* List of activities and holdings
* and many more...
## How To Use
### Installation
Install the package via pip. This will also install the dependency loguru for logging purposes.
```bash
# Install the package
$ pip install parqet
```
### Usage
Create a `Portfolio` object and get the name of the portfolio.
```python
# Import the package
from parqet import portfolio
# Create a portfolio object
portfolio = Portfolio("YOUR_PORTFOLIO_ID")
# Extract the portfolio name and print it
print(portfolio.get_name())
```
> **Note**
> Your portfolio has to be set to public to access it via the API.
<details>
<summary>Full list of functions</summary>
<table>
<thead>
<tr>
<th>Function Name</th>
<th>Description</th>
<th>Return Type</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td>get_name()</td>
<td>Returns the name of the portfolio.</td>
<td><code>str</code></td>
<td><code>portfolio.get_name()</code> returns <code>"My Portfolio"</code></td>
</tr>
<tr>
<td>get_value()</td>
<td>Returns the current value of the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_value()</code> returns <code>6000.0</code></td>
</tr>
<tr>
<td>get_total_gain_gross()</td>
<td>Returns the total gross gain of the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_total_gain_gross()</code> returns <code>1000.0</code></td>
</tr>
<tr>
<td>get_total_invested()</td>
<td>Returns the total amount invested in the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_total_invested()</code> returns <code>5000.0</code></td>
</tr>
<tr>
<td>get_total_gain_net()</td>
<td>Returns the total net gain of the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_total_gain_net()</code> returns <code>800.0</code></td>
</tr>
<tr>
<td>get_total_return_gross()</td>
<td>Returns the total gross return of the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_total_return_gross()</code> returns <code>20.0</code></td>
</tr>
<tr>
<td>get_total_return_net()</td>
<td>Returns the total net return of the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_total_return_net()</code> returns <code>16.0</code></td>
</tr>
<tr>
<td>get_fees()</td>
<td>Returns the total fees paid for the portfolio.</td>
<td><code>float</code></td>
<td><code>portfolio.get_fees()</code> returns <code>50.0</code></td>
</tr>
<tr>
<td>get_created_at()</td>
<td>Returns the date of the portfolio's creation.</td>
<td><code>str</code></td>
<td><code>portfolio.get_created_at()</code> returns <code>"2023-05-25T20:45:04.802Z"</code></td>
</tr>
<tr>
<td>get_holdings()</td>
<td>Returns a list of holdings in the portfolio.</td>
<td><code>list</code></td>
<td><code>portfolio.get_holdings()</code> returns <code>[{...}]</code></td>
</tr>
<tr>
<td>get_activities()</td>
<td>Returns a list of activities of the holdings in the portfolio.</td>
<td><code>list</code></td>
<td><code>portfolio.get_activities()</code> returns <code>[{...}]</code></td>
</tr>
</tbody>
</table>
</details>
## Download
If you don't want to install the package via pip, you can instead [download](https://github.com/JoghurtConnaisseur/parqet-python/releases/latest) the latest release of the sourcecode.
## Credits
This software uses [Loguru](https://github.com/Delgan/loguru) for logging.
## License
GPL
---
> GitHub [@JoghurtConnaisseur](https://github.com/JoghurtConnaisseur) ·
Raw data
{
"_id": null,
"home_page": "",
"name": "parqet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "parqet,api,fintech,portfolio,investing,stocks",
"author": "JoghurtConnaisseur",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/30/65/4265a8d66833a2ca3348d0b7e8868675e3619a5c0f98d66943376b328ab2/parqet-1.0.4.tar.gz",
"platform": null,
"description": "\n<h1 align=\"center\">\n <br>\n <img src=\"https://raw.githubusercontent.com/JoghurtConnaisseur/parqet-python/main/img/Parqet.png\" alt=\"Parqet Logo\" width=\"200\">\n <img src=\"https://raw.githubusercontent.com/JoghurtConnaisseur/parqet-python/main/img/python.png\" alt=\"Python Logo\" width=\"200\">\n<br>\nparqet-python\n<br>\n</h1>\n\n<h4 align=\"center\">An inoffical package to communicate with the <a href=\"https://www.parqet.com/\" target=\"_blank\">Parqet</a> API.</h4>\n\n\n<p align=\"center\">\n <a href=\"#key-features\">Key Features</a> \u2022\n <a href=\"#how-to-use\">How To Use</a> \u2022\n <a href=\"#download\">Download</a> \u2022\n <a href=\"#credits\">Credits</a> \u2022\n <a href=\"#related\">Related</a> \u2022\n <a href=\"#license\">License</a>\n</p>\n\n## Key Features\n\nThe parqet-python package will use the <a href=\"https://www.parqet.com/\" target=\"_blank\">Parqet</a> API to gather information about public Portfolios. Available information includes:\n* Portfolio name\n* Portfolio value\n* Gain gross / net\n* Total invested\n* List of activities and holdings\n* and many more...\n\n## How To Use\n\n### Installation\n\nInstall the package via pip. This will also install the dependency loguru for logging purposes.\n\n```bash\n# Install the package\n$ pip install parqet\n```\n\n### Usage\nCreate a `Portfolio` object and get the name of the portfolio.\n\n```python\n# Import the package\nfrom parqet import portfolio\n\n# Create a portfolio object\nportfolio = Portfolio(\"YOUR_PORTFOLIO_ID\")\n\n# Extract the portfolio name and print it\nprint(portfolio.get_name())\n```\n\n\n> **Note**\n> Your portfolio has to be set to public to access it via the API.\n\n<details>\n <summary>Full list of functions</summary>\n <table>\n <thead>\n <tr>\n <th>Function Name</th>\n <th>Description</th>\n <th>Return Type</th>\n <th>Example</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>get_name()</td>\n <td>Returns the name of the portfolio.</td>\n <td><code>str</code></td>\n <td><code>portfolio.get_name()</code> returns <code>\"My Portfolio\"</code></td>\n </tr>\n <tr>\n <td>get_value()</td>\n <td>Returns the current value of the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_value()</code> returns <code>6000.0</code></td>\n </tr>\n <tr>\n <td>get_total_gain_gross()</td>\n <td>Returns the total gross gain of the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_total_gain_gross()</code> returns <code>1000.0</code></td>\n </tr>\n <tr>\n <td>get_total_invested()</td>\n <td>Returns the total amount invested in the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_total_invested()</code> returns <code>5000.0</code></td>\n </tr>\n <tr>\n <td>get_total_gain_net()</td>\n <td>Returns the total net gain of the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_total_gain_net()</code> returns <code>800.0</code></td>\n </tr>\n <tr>\n <td>get_total_return_gross()</td>\n <td>Returns the total gross return of the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_total_return_gross()</code> returns <code>20.0</code></td>\n </tr>\n <tr>\n <td>get_total_return_net()</td>\n <td>Returns the total net return of the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_total_return_net()</code> returns <code>16.0</code></td>\n </tr>\n <tr>\n <td>get_fees()</td>\n <td>Returns the total fees paid for the portfolio.</td>\n <td><code>float</code></td>\n <td><code>portfolio.get_fees()</code> returns <code>50.0</code></td>\n </tr>\n <tr>\n <td>get_created_at()</td>\n <td>Returns the date of the portfolio's creation.</td>\n <td><code>str</code></td>\n <td><code>portfolio.get_created_at()</code> returns <code>\"2023-05-25T20:45:04.802Z\"</code></td>\n </tr>\n <tr>\n <td>get_holdings()</td>\n <td>Returns a list of holdings in the portfolio.</td>\n <td><code>list</code></td>\n <td><code>portfolio.get_holdings()</code> returns <code>[{...}]</code></td>\n </tr>\n <tr>\n <td>get_activities()</td>\n <td>Returns a list of activities of the holdings in the portfolio.</td>\n <td><code>list</code></td>\n <td><code>portfolio.get_activities()</code> returns <code>[{...}]</code></td>\n </tr>\n </tbody>\n</table>\n</details>\n\n## Download\n\nIf you don't want to install the package via pip, you can instead [download](https://github.com/JoghurtConnaisseur/parqet-python/releases/latest) the latest release of the sourcecode.\n\n## Credits\n\nThis software uses [Loguru](https://github.com/Delgan/loguru) for logging. \n\n## License\n\nGPL\n\n---\n\n> GitHub [@JoghurtConnaisseur](https://github.com/JoghurtConnaisseur) · \n\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple package to interact with the Parqet API.",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/JoghurtConnaisseur/parqet-python/"
},
"split_keywords": [
"parqet",
"api",
"fintech",
"portfolio",
"investing",
"stocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b22e430f1c3877e343f3923721fe8034600cdcb660d39ea540e9ff4ec73ff779",
"md5": "b73b4adc382fa3d38fc0b2f9b3ffd318",
"sha256": "f444e2f6c18790fda66a84d197a407c200dbb34212e66d565de8987092549541"
},
"downloads": -1,
"filename": "parqet-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b73b4adc382fa3d38fc0b2f9b3ffd318",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16149,
"upload_time": "2023-10-04T12:42:29",
"upload_time_iso_8601": "2023-10-04T12:42:29.695966Z",
"url": "https://files.pythonhosted.org/packages/b2/2e/430f1c3877e343f3923721fe8034600cdcb660d39ea540e9ff4ec73ff779/parqet-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30654265a8d66833a2ca3348d0b7e8868675e3619a5c0f98d66943376b328ab2",
"md5": "4e55912d68baa24cef7aded2747ee0b1",
"sha256": "14dd06c4a1efb4ddd5360e76539131bd7e98d89f7764988250247d0699539b05"
},
"downloads": -1,
"filename": "parqet-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "4e55912d68baa24cef7aded2747ee0b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15928,
"upload_time": "2023-10-04T12:42:30",
"upload_time_iso_8601": "2023-10-04T12:42:30.863093Z",
"url": "https://files.pythonhosted.org/packages/30/65/4265a8d66833a2ca3348d0b7e8868675e3619a5c0f98d66943376b328ab2/parqet-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 12:42:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JoghurtConnaisseur",
"github_project": "parqet-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "parqet"
}
JSON
