Metadata-Version: 2.1
Name: marketpanda
Version: 0.1.8
Summary: MarketVault access library
License: MIT
Author: Fayssal El Mofatiche
Author-email: fayssal.elmofatiche@dnbf.tech
Requires-Python: >=3.11,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: cpi (>=1.0.21,<2.0.0)
Requires-Dist: gdown (>=4.7.1,<5.0.0)
Requires-Dist: pandas (>=2.1.1,<3.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# Market Panda
<img src="assets/marketpanda_logo_1.png" alt="Market Panda Logo" width="300" height="300"/>


This project offers a interface marketvault, a database that serves a securities database for investment research and algorithmic trading. It can either work with an offline marketvault instance or the online service.

## Technologies

The project utilizes python 3.10 along with the following packages:

- [pandas](https://pandas.pydata.org/) - Python software library for data manipulation.
- [requests](https://pypi.org/project/requests/) - Python library that makes HTTP requests simpler. 

Other technologies that were utilized within this project are listed here:

- [Docker](https://docs.docker.com/) - Platform that offers virtual software packages within unique containers. 


## Installation Guide

Clone the repository to your desired location, and confirm that python 3.7 or greater and the packages listed in the Technologies section are installed. The offline version is intended for educational and personal purposes.

```python
pip install marketpanda
```

## Getting Started

coming soon ...

## Contributors

- Fayssal El Mofatiche: fayssal.elmofatiche@dnbf.tech // [LinkedIn](https://www.linkedin.com/in/elmofatiche/)

## License

MIT License

Copyright (c) [2023] [Fayssal El Mofatiche]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
