https://github.com/pedrohenriquebr/pegasus
Finance Reporting Automation
https://github.com/pedrohenriquebr/pegasus
excel finance financial numpy pandas python python3 report
Last synced: 9 months ago
JSON representation
Finance Reporting Automation
- Host: GitHub
- URL: https://github.com/pedrohenriquebr/pegasus
- Owner: pedrohenriquebr
- License: gpl-2.0
- Created: 2021-07-30T00:08:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-07T18:16:52.000Z (about 4 years ago)
- Last Synced: 2025-02-17T15:19:35.091Z (12 months ago)
- Topics: excel, finance, financial, numpy, pandas, python, python3, report
- Language: Python
- Homepage:
- Size: 1.66 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Pegasus
Finance report
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
### Built With
* [Python 3.9.5](https://www.python.org/downloads/release/python-395/)
* [Pandas](https://pandas.pydata.org/docs/getting_started/index.html)
* [Openpyxl](https://openpyxl.readthedocs.io/en/stable/)
* [Flask](https://flask.palletsprojects.com/en/2.0.x/)
* [gspread](https://docs.gspread.org/en/v4.0.1/)
* [SheetsORM](https://pypi.org/project/sheetsorm/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
- [Create credentials in Google API Console](https://docs.gspread.org/en/latest/oauth2.html)
- [Python 3.9.5](https://www.python.org/downloads/release/python-395/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/pedrohenriquebr/Pegasus.git
```
2. Install packages
```sh
pip install -r requirements.txt
```
# Usage
## local environment
### Frontend
```bash
$ cd frontend
$ yarn
$ yarn start
```
### Backend
```bash
$ cd backend
$ run.dev.bat
```
### Setting up the environment
open the .env file and set the following variables:
```bash
CREDENTIALS_FILE_URL=a link or path to the credentials file
ENV=dev
PASSWORD=provide a password to access the web app
SPREADSHEET_NAME=Spreadsheet name
USER=username
USER_EMAIL=email to own the spreadsheet
REACT_APP_PASSWORD=same password
REACT_APP_USER=same user
```
## Using releases
Download the latest release from [GitHub releases](https://github.com/pedrohenriquebr/Pegasus/releases)
Extract the archive
Enter the directory
Run the following command
For Windows:
```bash
$ install.bat
$ run.bat
```
For unix-like systems:
```bash
$ install.sh
$ run.sh
```
Open the api directory and changes the .env file
remove the line with ENV=dev
Fill the lines with your credentials.
> Note: the user and password are the same as the ones used to access the web app. It is used only for the authentication.
## Roadmap
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GPL-2 License. See `LICENSE` for more information.
## Acknowledgements
* []()
* []()
* []()
[contributors-shield]: https://img.shields.io/github/contributors/pedrohenriquebr/Pegasus.svg?style=for-the-badge
[contributors-url]: https://github.com/pedrohenriquebr/Pegasus/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/pedrohenriquebr/Pegasus.svg?style=for-the-badge
[forks-url]: https://github.com/pedrohenriquebr/Pegasus/network/members
[stars-shield]: https://img.shields.io/github/stars/pedrohenriquebr/Pegasus.svg?style=for-the-badge
[stars-url]: https://github.com/pedrohenriquebr/repo/stargazers
[issues-shield]: https://img.shields.io/github/issues/pedrohenriquebr/Pegasus.svg?style=for-the-badge
[issues-url]: https://github.com/pedrohenriquebr/Pegasus/issues
[license-shield]: https://img.shields.io/github/license/pedrohenriquebr/Pegasus.svg?style=for-the-badge
[license-url]: https://github.com/pedrohenriquebr/Pegasus/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/pedro-henrique-braga-da-silva