Metadata-Version: 2.4
Name: freeports_analysis
Version: 0.0.4
Summary: Script for dumping a csv from different finance reports about ethical aspects
Author-email: Oreste Sciacqualegni <orestesciacqualegni@tutanota.com>
Maintainer-email: Oreste Sciacqualegni <orestesciacqualegni@tutanota.com>
License-Expression: GPL-3.0
Project-URL: github, https://github.com/GVoreste/analysis_finance_reports
Project-URL: documentation, https://docs.freeports.org
Project-URL: homepage, https://www.freeports.org
Keywords: finance,pdf,ethic,economy,datascience
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib_resources
Requires-Dist: rapidfuzz
Requires-Dist: dotenv
Requires-Dist: pyyaml
Requires-Dist: pandas
Requires-Dist: requests
Requires-Dist: PyMuPDF
Requires-Dist: lxml
Dynamic: license-file

# Finance reports analysis ([Freeports](https://www.freeports.org))
This project is intended parse finance pdf reports and create `CSV` dataset.
The purpose of the project and related infos can be found at the [*official website*](https://www.freeports.org).

## Installation
There are for now 2 installation method:
- using `pip` *(Recommended)*
- from source
### Using `pip`
Install in a python virtual environment launching
```bash
pip install freeports_analysis
```
### From source
> Requirements:
> You need to have the python `build` package. 
> You can install it in your virtual environment with `pip install build`
1. Clone the repository:
```bash
git clone https://github.com/GVoreste/analysis_finance_reports.git
```
2. `cd` into the created directory
```bash
cd analysis_finance_reports
```
3. build the package
```bash
python -m build .
```
4. install local package
```bash
pip install .
```
5. enjoy


## Quickstart
To start use the command provided with the library call
```bash
freeports -h
```
to see the options. All the option can be provided as environment variables.
If you want to use `freeports` as a python library write in you code
```python
import freeports_analysis as fra
```

## Usage
To have a complete overview of the package look at the [full documentation](https://docs.freeports.org).
